diff --git a/README.md b/README.md index 7e648fa..c87f666 100644 --- a/README.md +++ b/README.md @@ -33,137 +33,6 @@ This package for YunoHost used [django-yunohost-integration](https://github.com/ **Shipped version:** 0.3.2~ynh1 -## Disclaimers / important information - -## Settings and upgrades - -Almost everything related to django-fmd's configuration is handled in a `"../conf/settings.py"` file. -You can edit the file `/opt/yunohost/django-fmd/local_settings.py` to enable or disable features. - -Test sending emails: - -```bash -ssh admin@yourdomain.tld -root@yunohost:~# cd /opt/yunohost/django-fmd/ -root@yunohost:/opt/yunohost/django-fmd# source venv/bin/activate -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py sendtestemail --admins -``` - -Background info: Error mails are send to all [settings.ADMINS](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-ADMINS). By default the YunoHost admin is inserted here. -To check current ADMINS run: - -```bash -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py sendtestemail --admins -``` - -If you prefere to send error emails to a extrnal email address, just do something like this: - -```bash -echo "ADMINS = (('Your Name', 'example@domain.tld'),)" >> /opt/yunohost/django-fmd/local_settings.py -``` - -To check the effective settings, run this: -```bash -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py diffsettings -``` - - -# Miscellaneous - - -## SSO authentication - -[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration): - -* First user (`$YNH_APP_ARG_ADMIN`) will be created as Django's super user -* All new users will be created as normal users -* Login via SSO is fully supported -* User Email, First / Last name will be updated from SSO data - - ---- - -# Yunohost developer commands - -To remove call e.g.: -```bash -sudo yunohost app remove django-fmd -``` - -Backup / remove / restore cycle, e.g.: -```bash -yunohost backup create --apps django-fmd -yunohost backup list -archives: - - django-fmd-pre-upgrade1 - - 20201223-163434 -yunohost app remove django-fmd -yunohost backup restore 20201223-163434 --apps django-fmd -``` - -Debug installation, e.g.: -```bash -root@yunohost:~# ls -la /var/www/django-fmd/ -total 18 -drwxr-xr-x 4 root root 4 Dec 8 08:36 . -drwxr-xr-x 6 root root 6 Dec 8 08:36 .. -drwxr-xr-x 2 root root 2 Dec 8 08:36 media -drwxr-xr-x 7 root root 8 Dec 8 08:40 static - -root@yunohost:~# ls -la /opt/yunohost/django-fmd/ -total 58 -drwxr-xr-x 5 django-fmd django-fmd 11 Dec 8 08:39 . -drwxr-xr-x 3 root root 3 Dec 8 08:36 .. --rw-r--r-- 1 django-fmd django-fmd 460 Dec 8 08:39 gunicorn.conf.py --rw-r--r-- 1 django-fmd django-fmd 0 Dec 8 08:39 local_settings.py --rwxr-xr-x 1 django-fmd django-fmd 274 Dec 8 08:39 manage.py --rw-r--r-- 1 django-fmd django-fmd 171 Dec 8 08:39 secret.txt -drwxr-xr-x 6 django-fmd django-fmd 6 Dec 8 08:37 venv --rw-r--r-- 1 django-fmd django-fmd 115 Dec 8 08:39 wsgi.py --rw-r--r-- 1 django-fmd django-fmd 4737 Dec 8 08:39 settings.py - -root@yunohost:~# cd /opt/yunohost/django-fmd/ -root@yunohost:/opt/yunohost/django-fmd# source venv/bin/activate -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py check -django-fmd v0.8.2 (Django v2.2.17) -DJANGO_SETTINGS_MODULE='settings' -PROJECT_PATH:/opt/yunohost/django-fmd/venv/lib/python3.7/site-packages -BASE_PATH:/opt/yunohost/django-fmd -System check identified no issues (0 silenced). - -root@yunohost:~# tail -f /var/log/django-fmd/django-fmd.log -root@yunohost:~# cat /etc/systemd/system/django-fmd.service - -root@yunohost:~# systemctl reload-or-restart django-fmd -root@yunohost:~# journalctl --unit=django-fmd --follow -``` - -## local test - -For quicker developing of django-fmd in the context of YunoHost app, -it's possible to run the Django developer server with the settings -and urls made for YunoHost installation. - -e.g.: -```bash -~$ git clone https://github.com/YunoHost-Apps/django-fmd_ynh.git -~$ cd django-fmd_ynh/ -~/django-fmd_ynh$ make -install-poetry install or update poetry -install install django-fmd via poetry -update update the sources and installation -local-test Run local_test.py to run django-fmd_ynh locally -~/django-fmd_ynh$ make install-poetry -~/django-fmd_ynh$ make install -~/django-fmd_ynh$ make local-test -``` - -Notes: - -* SQlite database will be used -* A super user with username `test` and password `test` is created -* The page is available under `http://127.0.0.1:8000/app_path/` - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 10292e9..b97a83a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -33,137 +33,6 @@ This package for YunoHost used [django-yunohost-integration](https://github.com/ **Version incluse :** 0.3.2~ynh1 -## Avertissements / informations importantes - -## Settings and upgrades - -Almost everything related to django-fmd's configuration is handled in a `"../conf/settings.py"` file. -You can edit the file `/opt/yunohost/django-fmd/local_settings.py` to enable or disable features. - -Test sending emails: - -```bash -ssh admin@yourdomain.tld -root@yunohost:~# cd /opt/yunohost/django-fmd/ -root@yunohost:/opt/yunohost/django-fmd# source venv/bin/activate -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py sendtestemail --admins -``` - -Background info: Error mails are send to all [settings.ADMINS](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-ADMINS). By default the YunoHost admin is inserted here. -To check current ADMINS run: - -```bash -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py sendtestemail --admins -``` - -If you prefere to send error emails to a extrnal email address, just do something like this: - -```bash -echo "ADMINS = (('Your Name', 'example@domain.tld'),)" >> /opt/yunohost/django-fmd/local_settings.py -``` - -To check the effective settings, run this: -```bash -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py diffsettings -``` - - -# Miscellaneous - - -## SSO authentication - -[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration): - -* First user (`$YNH_APP_ARG_ADMIN`) will be created as Django's super user -* All new users will be created as normal users -* Login via SSO is fully supported -* User Email, First / Last name will be updated from SSO data - - ---- - -# Yunohost developer commands - -To remove call e.g.: -```bash -sudo yunohost app remove django-fmd -``` - -Backup / remove / restore cycle, e.g.: -```bash -yunohost backup create --apps django-fmd -yunohost backup list -archives: - - django-fmd-pre-upgrade1 - - 20201223-163434 -yunohost app remove django-fmd -yunohost backup restore 20201223-163434 --apps django-fmd -``` - -Debug installation, e.g.: -```bash -root@yunohost:~# ls -la /var/www/django-fmd/ -total 18 -drwxr-xr-x 4 root root 4 Dec 8 08:36 . -drwxr-xr-x 6 root root 6 Dec 8 08:36 .. -drwxr-xr-x 2 root root 2 Dec 8 08:36 media -drwxr-xr-x 7 root root 8 Dec 8 08:40 static - -root@yunohost:~# ls -la /opt/yunohost/django-fmd/ -total 58 -drwxr-xr-x 5 django-fmd django-fmd 11 Dec 8 08:39 . -drwxr-xr-x 3 root root 3 Dec 8 08:36 .. --rw-r--r-- 1 django-fmd django-fmd 460 Dec 8 08:39 gunicorn.conf.py --rw-r--r-- 1 django-fmd django-fmd 0 Dec 8 08:39 local_settings.py --rwxr-xr-x 1 django-fmd django-fmd 274 Dec 8 08:39 manage.py --rw-r--r-- 1 django-fmd django-fmd 171 Dec 8 08:39 secret.txt -drwxr-xr-x 6 django-fmd django-fmd 6 Dec 8 08:37 venv --rw-r--r-- 1 django-fmd django-fmd 115 Dec 8 08:39 wsgi.py --rw-r--r-- 1 django-fmd django-fmd 4737 Dec 8 08:39 settings.py - -root@yunohost:~# cd /opt/yunohost/django-fmd/ -root@yunohost:/opt/yunohost/django-fmd# source venv/bin/activate -(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py check -django-fmd v0.8.2 (Django v2.2.17) -DJANGO_SETTINGS_MODULE='settings' -PROJECT_PATH:/opt/yunohost/django-fmd/venv/lib/python3.7/site-packages -BASE_PATH:/opt/yunohost/django-fmd -System check identified no issues (0 silenced). - -root@yunohost:~# tail -f /var/log/django-fmd/django-fmd.log -root@yunohost:~# cat /etc/systemd/system/django-fmd.service - -root@yunohost:~# systemctl reload-or-restart django-fmd -root@yunohost:~# journalctl --unit=django-fmd --follow -``` - -## local test - -For quicker developing of django-fmd in the context of YunoHost app, -it's possible to run the Django developer server with the settings -and urls made for YunoHost installation. - -e.g.: -```bash -~$ git clone https://github.com/YunoHost-Apps/django-fmd_ynh.git -~$ cd django-fmd_ynh/ -~/django-fmd_ynh$ make -install-poetry install or update poetry -install install django-fmd via poetry -update update the sources and installation -local-test Run local_test.py to run django-fmd_ynh locally -~/django-fmd_ynh$ make install-poetry -~/django-fmd_ynh$ make install -~/django-fmd_ynh$ make local-test -``` - -Notes: - -* SQlite database will be used -* A super user with username `test` and password `test` is created -* The page is available under `http://127.0.0.1:8000/app_path/` - ## Documentations et ressources * Site officiel de l’app :