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 : diff --git a/check_process b/check_process deleted file mode 100644 index 5615399..0000000 --- a/check_process +++ /dev/null @@ -1,33 +0,0 @@ -# See here for more information -# https://github.com/YunoHost/package_check#syntax-check_process-file - -# Move this file from check_process.default to check_process when you have filled it. - -;; Test complet - ; Manifest - domain="domain.tld" (DOMAIN) - path="/path" (PATH) - admin="john" (USER) - is_public=1 (PUBLIC|public=1|private=0) - password="pass" - port="666" (PORT) - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=0 - setup_public=1 - upgrade=1 - backup_restore=1 - multi_instance=0 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=CommitHash - name=Name and date of the commit. - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& - diff --git a/conf/django-fmd.service b/conf/django-fmd.service index f81544f..ac3ba69 100644 --- a/conf/django-fmd.service +++ b/conf/django-fmd.service @@ -5,9 +5,9 @@ After=redis.service postgresql.service [Service] User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ +WorkingDirectory=__INSTALL_DIR__/ -ExecStart=__FINALPATH__/venv/bin/gunicorn --config __FINALPATH__/gunicorn.conf.py wsgi +ExecStart=__INSTALL_DIR__/venv/bin/gunicorn --config __INSTALL_DIR__/gunicorn.conf.py wsgi StandardOutput=syslog StandardError=syslog diff --git a/conf/gunicorn.conf.py b/conf/gunicorn.conf.py index f49a397..4bf1542 100644 --- a/conf/gunicorn.conf.py +++ b/conf/gunicorn.conf.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Configuration for Gunicorn """ @@ -13,8 +14,8 @@ workers = multiprocessing.cpu_count() * 2 + 1 loglevel = 'info' # https://docs.gunicorn.org/en/latest/settings.html#logging -accesslog = '__LOG_FILE__' -errorlog = '__LOG_FILE__' +accesslog = '/var/log/__APP__/__APP__.log' +errorlog = '/var/log/__APP__/__APP__.log' # https://docs.gunicorn.org/en/latest/settings.html#pidfile -pidfile = '__FINALPATH__/gunicorn.pid' +pidfile = '__INSTALL_DIR__/gunicorn.pid' diff --git a/conf/local_settings.py b/conf/local_settings.py index 57b6600..cdc846d 100644 --- a/conf/local_settings.py +++ b/conf/local_settings.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Here it's possible to overwrite everything in settings.py diff --git a/conf/manage.py b/conf/manage.py index ec26808..a85e3b1 100755 --- a/conf/manage.py +++ b/conf/manage.py @@ -1,4 +1,4 @@ -#!__FINALPATH__/venv/bin/python +#!/usr/bin/env python3 import os import sys diff --git a/conf/nginx.conf b/conf/nginx.conf index 867d5ef..2cc86fe 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/static/ { # Service static files by nginx # e.g.: /var/www/$app/static - alias __PUBLIC_PATH__/static/; + alias __INSTALL_DIR__/public/static/; expires 30d; } diff --git a/conf/settings.py b/conf/settings.py index cb9b166..06ae805 100644 --- a/conf/settings.py +++ b/conf/settings.py @@ -1,15 +1,16 @@ +#!/usr/bin/env python3 ################################################################################ ################################################################################ # Please do not modify this file, it will be reset at the next update. -# You can edit the file __FINALPATH__/local_settings.py and add/modify the settings you need. +# You can edit the file __INSTALL_DIR__/local_settings.py and add/modify the settings you need. # The parameters you add in local_settings.py will overwrite these, # but you can use the options and documentation in this file to find out what can be done. ################################################################################ ################################################################################ -from pathlib import Path as __Path +from pathlib import Path from django_yunohost_integration.base_settings import * # noqa:F401,F403 from django_yunohost_integration.secret_key import get_or_create_secret as __get_or_create_secret @@ -20,17 +21,17 @@ from findmydevice_project.settings.base import * # noqa:F401,F403 from django_yunohost_integration.base_settings import LOGGING # noqa:F401 isort:skip -FINALPATH = __Path('__FINALPATH__') # /opt/yunohost/$app -assert FINALPATH.is_dir(), f'Directory not exists: {FINALPATH}' +INSTALL_DIR = Path('__INSTALL_DIR__') +assert INSTALL_DIR.is_dir(), f'Directory not exists: {INSTALL_DIR}' -PUBLIC_PATH = __Path('__PUBLIC_PATH__') # /var/www/$app +PUBLIC_PATH = Path('__INSTALL_DIR__/public') assert PUBLIC_PATH.is_dir(), f'Directory not exists: {PUBLIC_PATH}' -LOG_FILE = __Path('__LOG_FILE__') # /var/log/$app/django_example_ynh.log +LOG_FILE = Path('/var/log/__APP__/__APP__.log') assert LOG_FILE.is_file(), f'File not exists: {LOG_FILE}' -PATH_URL = '__PATH_URL__' # $YNH_APP_ARG_PATH -PATH_URL = PATH_URL.strip('/') +PATH = '__PATH__' # $YNH_APP_ARG_PATH +PATH = PATH.strip('/') # ----------------------------------------------------------------------------- # config_panel.toml settings: @@ -48,7 +49,7 @@ DEFAULT_FROM_EMAIL = '__DEFAULT_FROM_EMAIL__' # Function that will be called to finalize a user profile: YNH_SETUP_USER = 'setup_user.setup_project_user' -SECRET_KEY = __get_or_create_secret(FINALPATH / 'secret.txt') # /opt/yunohost/$app/secret.txt +SECRET_KEY = __get_or_create_secret(INSTALL_DIR / 'secret.txt') INSTALLED_APPS += [ 'axes', # https://github.com/jazzband/django-axes @@ -139,9 +140,9 @@ CACHES = { # _____________________________________________________________________________ # Static files (CSS, JavaScript, Images) -if PATH_URL: - STATIC_URL = f'/{PATH_URL}/static/' - MEDIA_URL = f'/{PATH_URL}/media/' +if PATH: + STATIC_URL = f'/{PATH}/static/' + MEDIA_URL = f'/{PATH}/media/' else: # Installed to domain root, without a path prefix? STATIC_URL = '/static/' diff --git a/conf/setup_user.py b/conf/setup_user.py index d838d3e..2a348ad 100644 --- a/conf/setup_user.py +++ b/conf/setup_user.py @@ -1,3 +1,5 @@ +#!/usr/bin/env python3 + def setup_project_user(user): """ All users used the Django admin, so we need to set the "staff" user flag. diff --git a/conf/systemd.service b/conf/systemd.service index 6b6cc92..870ad4c 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -5,9 +5,9 @@ After=redis.service postgresql.service [Service] User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ +WorkingDirectory=__INSTALL_DIR__/ -ExecStart=__FINALPATH__/venv/bin/gunicorn --config __FINALPATH__/gunicorn.conf.py wsgi +ExecStart=__INSTALL_DIR__/venv/bin/gunicorn --config __INSTALL_DIR__/gunicorn.conf.py wsgi StandardOutput=syslog StandardError=syslog diff --git a/conf/urls.py b/conf/urls.py index ff797df..4fe0289 100644 --- a/conf/urls.py +++ b/conf/urls.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ urls.py ~~~~~~~ @@ -9,14 +10,14 @@ from django.views.static import serve import findmydevice -if settings.PATH_URL: - # settings.PATH_URL is the $YNH_APP_ARG_PATH - # Prefix all urls with "PATH_URL": +if settings.PATH: + # settings.PATH is the $YNH_APP_ARG_PATH + # Prefix all urls with "PATH": urlpatterns = [ - path(f'{settings.PATH_URL}/', include('findmydevice_project.urls')), + path(f'{settings.PATH}/', include('findmydevice_project.urls')), # # TODO: Serve from nginx server ;) - path(f'{settings.PATH_URL}/', serve, {'document_root': findmydevice.WEB_PATH}) + path(f'{settings.PATH}/', serve, {'document_root': findmydevice.WEB_PATH}) ] else: # Installed to domain root, without a path prefix diff --git a/config_panel.toml b/config_panel.toml index d020b20..7295610 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -14,13 +14,13 @@ services = ["__APP__"] ask = "from email" type = "email" help = "Default email address to use for various automated emails." - bind = "default_from_email:__FINALPATH__/settings.py" + bind = "default_from_email:__INSTALL_DIR__/settings.py" [main.config.admin_email] ask = "ADMIN email" type = "email" help = "EMail address for error emails." - bind = "admin_email:__FINALPATH__/settings.py" + bind = "admin_email:__INSTALL_DIR__/settings.py" [main.config.debug_enabled] ask = "DEBUG mode" @@ -28,11 +28,11 @@ services = ["__APP__"] yes = "1" no = "0" help = "Should be never enabled in production!" - bind = "debug_enabled:__FINALPATH__/settings.py" + bind = "debug_enabled:__INSTALL_DIR__/settings.py" [main.config.log_level] type = "string" ask = "Log Level" choices = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"] default = "WARNING" - bind = "log_level:__FINALPATH__/settings.py" + bind = "log_level:__INSTALL_DIR__/settings.py" diff --git a/doc/ADMIN.md b/doc/ADMIN.md new file mode 100644 index 0000000..9a35750 --- /dev/null +++ b/doc/ADMIN.md @@ -0,0 +1,32 @@ +## 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 +``` diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index c7cd6cc..0000000 --- a/doc/DISCLAIMER.md +++ /dev/null @@ -1,128 +0,0 @@ -## 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/` diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 5f67ea3..0000000 --- a/manifest.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "name": "django-fmd", - "id": "django-fmd", - "packaging_format": 1, - "description": { - "en": "Web based FritzBox management using Python/Django." - }, - "version": "0.3.2~ynh1", - "url": "https://github.com/YunoHost-Apps/django-fmd_ynh", - "upstream": { - "license": "GPL-3.0", - "website": "https://gitlab.com/jedie/django-find-my-device", - "code": "https://gitlab.com/jedie/django-find-my-device" - }, - "license": "GPL-3.0", - "maintainer": { - "name": "Jens Diemer", - "email": "django-fmd_ynh@jensdiemer.de" - }, - "previous_maintainers": [], - "requirements": { - "yunohost": ">= 4.4" - }, - "multi_instance": false, - "services": [ - "nginx", "postgresql", "redis" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/fmd", - "default": "/fmd" - }, - { - "name": "admin", - "type": "user" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..1a62445 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,67 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "django-fmd" +name = "django-fmd" +description.en = "Web based FritzBox management using Python/Django." + +version = "0.3.2~ynh1" + +maintainers = ["Jens Diemer"] + +[upstream] +license = "GPL-3.0" +website = "https://gitlab.com/jedie/django-find-my-device" +code = "https://gitlab.com/jedie/django-find-my-device" + +[integration] +yunohost = ">= 4.4" +architectures = "all" +multi_instance = false +ldap = true +sso = true +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/fmd" + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.admin] + type = "user" + +[resources] + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.ports] + main.default = 8000 + + [resources.apt] + packages = [ + "build-essential", + "python3-dev", + "python3-pip", + "python3-venv", + "git", + "libpq-dev", + "postgresql", + "postgresql-contrib" + ] + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index ed1f773..79a602a 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,52 +1,33 @@ #!/bin/bash -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH - -admin=$YNH_APP_ARG_ADMIN -app=$YNH_APP_INSTANCE_NAME - -# Currently not used: django-fmd has no public pages, yet! -is_public=$YNH_APP_ARG_IS_PUBLIC - -#================================================= -# ARGUMENTS FROM CONFIG PANEL -#================================================= - -# 'debug_enabled' -> '__DEBUG_ENABLED__' -> settings.DEBUG -debug_enabled="0" - -# 'log_level' -> '__LOG_LEVEL__' -> settings.LOG_LEVEL -log_level="WARNING" - -# 'admin_email' -> '__ADMIN_EMAIL__' add in settings.ADMINS -admin_email="${admin}@${domain}" - -# 'default_from_email' -> '__DEFAULT_FROM_EMAIL__' -> settings.DEFAULT_FROM_EMAIL -default_from_email="${app}@${domain}" - -#================================================= -# SET CONSTANTS -#================================================= - -public_path=/var/www/$app -final_path=/opt/yunohost/$app -log_path=/var/log/$app -log_file="${log_path}/${app}.log" - #================================================= # COMMON VARIABLES #================================================= -# dependencies used by the app -pkg_dependencies="build-essential python3-dev python3-pip python3-venv git libpq-dev postgresql postgresql-contrib" + #================================================= -# Redis HELPERS +# PERSONAL HELPERS +#================================================= + +_install_fmd_venv() { + ynh_exec_as "$app" python3 -m venv --upgrade "$install_dir/venv" + + venvpython="$install_dir/venv/bin/python3" + + ynh_add_config --template="requirements.txt" --destination="$install_dir/requirements.txt" + + ynh_exec_as "$app" "$venvpython" -m ensurepip + ynh_exec_as "$app" "$venvpython" -m pip install --upgrade wheel pip setuptools + ynh_exec_as "$app" "$venvpython" -m pip install --no-deps -r "$install_dir/requirements.txt" +} + +#================================================= +# EXPERIMENTAL HELPERS +#================================================= + +#================================================= +# FUTURE OFFICIAL HELPERS #================================================= # get the first available redis database @@ -54,27 +35,27 @@ pkg_dependencies="build-essential python3-dev python3-pip python3-venv git libpq # usage: ynh_redis_get_free_db # | returns: the database number to use ynh_redis_get_free_db() { - local result max db - result=$(redis-cli INFO keyspace) + local result max db + result=$(redis-cli INFO keyspace) - # get the num - max=$(cat /etc/redis/redis.conf | grep ^databases | grep -Eow "[0-9]+") + # get the num + max=$(cat /etc/redis/redis.conf | grep ^databases | grep -Eow "[0-9]+") - db=0 - # default Debian setting is 15 databases - for i in $(seq 0 "$max") - do - if ! echo "$result" | grep -q "db$i" - then - db=$i - break 1 - fi - db=-1 - done + db=0 + # default Debian setting is 15 databases + for i in $(seq 0 "$max") + do + if ! echo "$result" | grep -q "db$i" + then + db=$i + break 1 + fi + db=-1 + done - test "$db" -eq -1 && ynh_die "No available Redis databases..." + test "$db" -eq -1 && ynh_die "No available Redis databases..." - echo "$db" + echo "$db" } # Create a master password and set up global settings @@ -83,7 +64,6 @@ ynh_redis_get_free_db() { # usage: ynh_redis_remove_db database # | arg: database - the database to erase ynh_redis_remove_db() { - local db=$1 - redis-cli -n "$db" flushall + local db=$1 + redis-cli -n "$db" flushall } - diff --git a/scripts/backup b/scripts/backup index 308ba1c..1b514d4 100755 --- a/scripts/backup +++ b/scripts/backup @@ -9,21 +9,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -db_name=$(ynh_app_setting_get --app="$app" --key=db_name) - -domain=$(ynh_app_setting_get --app="$app" --key=domain) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -33,34 +18,26 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" -ynh_backup --src_path="$public_path" +ynh_backup --src_path="$install_dir" #================================================= -# BACKUP THE NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# BACKUP THE PostgreSQL DATABASE -#================================================= - -ynh_psql_dump_db --database="$db_name" > db.sql - -#================================================= -# SPECIFIC BACKUP -#================================================= -# BACKUP LOGROTATE -#================================================= +ynh_backup --src_path="/etc/systemd/system/$app.service" ynh_backup --src_path="/etc/logrotate.d/$app" -#================================================= -# BACKUP SYSTEMD -#================================================= +ynh_backup --src_path="/var/log/$app/" -ynh_backup --src_path="/etc/systemd/system/$app.service" +#================================================= +# BACKUP THE PostgreSQL DATABASE +#================================================= +ynh_print_info --message="Backing up the PostgreSQL database..." + +ynh_psql_dump_db --database="$db_name" > db.sql #================================================= # END OF SCRIPT diff --git a/scripts/change_url b/scripts/change_url index cb77f04..bca4fc3 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -6,81 +6,9 @@ # IMPORT GENERIC HELPERS #================================================= -YNH_APP_ARG_DOMAIN=$YNH_APP_NEW_DOMAIN -YNH_APP_ARG_PATH=$YNH_APP_NEW_PATH - source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -admin=$(ynh_app_setting_get --app="$app" --key=admin) -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -log_path=$(ynh_app_setting_get --app="$app" --key=log_path) - -port=$(ynh_app_setting_get --app="$app" --key=port) - -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) -db_name=$(ynh_sanitize_dbid --db_name="$app") -db_user=$db_name - -redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) - -#------------------------------------------------- -# config_panel.toml settings: - -debug_enabled=$(ynh_app_setting_get --app="$app" --key=debug_enabled) -log_level=$(ynh_app_setting_get --app="$app" --key=log_level) -admin_email=$(ynh_app_setting_get --app="$app" --key=admin_email) -default_from_email=$(ynh_app_setting_get --app="$app" --key=default_from_email) - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=40 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -95,31 +23,9 @@ ynh_systemd_action --service_name="$app" --action="stop" #================================================= # MODIFY URL IN NGINX CONF #================================================= -ynh_script_progression --message="Updating nginx web server configuration..." +ynh_script_progression --message="Updating NGINX web server configuration..." -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the nginx config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original nginx config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for nginx helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated nginx config - ynh_add_nginx_config "public_path" "port" -fi - -# Change the domain for nginx -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS @@ -128,10 +34,7 @@ fi #================================================= ynh_script_progression --message="Modify $app config file..." -domain=$YNH_APP_NEW_DOMAIN -path_url=$YNH_APP_NEW_PATH - -ynh_add_config --template="settings.py" --destination="$final_path/settings.py" +ynh_add_config --template="settings.py" --destination="$install_dir/settings.py" #================================================= # GENERIC FINALISATION @@ -142,13 +45,6 @@ ynh_script_progression --message="Starting systemd service '$app'..." --weight=5 ynh_systemd_action --service_name="$app" --action="start" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading nginx web server..." - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index b56bb3b..78ad9e8 100755 --- a/scripts/install +++ b/scripts/install @@ -7,60 +7,28 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors +mkdir -p "$install_dir/public/media" "$install_dir/public/static" +mkdir -p "$install_dir" -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." - -# Path for e.g. "static" files, served by nginx: -test ! -e "$public_path" || ynh_die --message="This path already contains a folder" - -# Path for own config files, e.g.: Django's settings.py: -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app="$app" --domain="$domain" --path_url="$path_url" - -mkdir -p "$public_path/media" "$public_path/static" -mkdir -p "$final_path" - -mkdir -p "$log_path" -touch "${log_file}" - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." - -ynh_app_setting_set --app="$app" --key=admin --value="$admin" -ynh_app_setting_set --app="$app" --key=public_path --value="$public_path" -ynh_app_setting_set --app="$app" --key=final_path --value="$final_path" -ynh_app_setting_set --app="$app" --key=log_path --value="$log_file" - -ynh_app_setting_set --app="$app" --key=domain --value="$domain" -ynh_app_setting_set --app="$app" --key=path --value="$path_url" - -# Find a free port -port=$(ynh_find_port --port=8000) -# Set port as application setting -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/setting -ynh_app_setting_set --app="$app" --key=port --value="$port" - -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) +mkdir -p "/var/log/$app" +touch "/var/log/$app/$app.log" redis_db=$(ynh_redis_get_free_db) ynh_app_setting_set --app="$app" --key=redis_db --value="$redis_db" -#------------------------------------------------- -# config_panel.toml settings: +# 'debug_enabled' -> '__DEBUG_ENABLED__' -> settings.DEBUG +debug_enabled="0" + +# 'log_level' -> '__LOG_LEVEL__' -> settings.LOG_LEVEL +log_level="WARNING" + +# 'admin_email' -> '__ADMIN_EMAIL__' add in settings.ADMINS +admin_email="${admin}@${domain}" + +# 'default_from_email' -> '__DEFAULT_FROM_EMAIL__' -> settings.DEFAULT_FROM_EMAIL +default_from_email="${app}@${domain}" + ynh_app_setting_set --app="$app" --key=debug_enabled --value="$debug_enabled" ynh_app_setting_set --app="$app" --key=log_level --value="$log_level" @@ -68,164 +36,74 @@ ynh_app_setting_set --app="$app" --key=admin_email --value="$admin_email" ynh_app_setting_set --app="$app" --key=default_from_email --value="$default_from_email" #================================================= -# STANDARD MODIFICATIONS +# INSTALLATION #================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing $app dependencies..." --weight=20 +ynh_script_progression --message="Installing project via pip..." --weight=45 -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" +_install_fmd_venv -#================================================= -# CREATE A PostgreSQL DATABASE -#================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." +mkdir -p "$install_dir/public/media" "$install_dir/public/static" -db_name=$(ynh_sanitize_dbid --db_name="$app") -db_user=$db_name -ynh_app_setting_set --app="$app" --key=db_name --value="$db_name" +chmod o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" -ynh_psql_test_if_first_run +mkdir -p "/var/log/$app" +touch "/var/log/$app/$app.log" -# Initialize database and store postgres password for upgrade -ynh_psql_setup_db --db_user="$db_user" --db_name="$db_name" - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring nginx web server..." - -# Create a dedicated nginx config -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/nginx -ynh_add_nginx_config "public_path" "port" - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user '$app'..." - -# A home directory for venv and settings etc. -ynh_system_user_create --username="$app" --home_dir="$final_path" --use_shell - -#================================================= -# PYTHON VIRTUALENV -#================================================= -ynh_script_progression --message="Create Python virtualenv..." --weight=5 - -# Always recreate everything fresh with current python version -ynh_secure_remove "${final_path}/venv" - -# Skip pip because of: https://github.com/YunoHost/issues/issues/1960 -python3 -m venv --without-pip "${final_path}/venv" - -cp ../conf/requirements.txt "$final_path/requirements.txt" -chown -R "$app:" "$final_path" - -#================================================= -# PIP INSTALLATION -#================================================= -ynh_script_progression --message="Install project via pip..." --weight=45 - -#run source in a 'sub shell' -( - set +o nounset - source "${final_path}/venv/bin/activate" - set -o nounset - ynh_exec_as $app $final_path/venv/bin/python3 -m ensurepip - ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade wheel pip setuptools - ynh_exec_as $app $final_path/venv/bin/pip3 install --no-deps -r "$final_path/requirements.txt" -) +chmod o-rwx "/var/log/$app" +chown -R "$app:$app" "/var/log/$app" #================================================= # copy config files # ================================================ ynh_script_progression --message="Create $app configuration files..." -ynh_add_config --template="gunicorn.conf.py" --destination="$final_path/gunicorn.conf.py" +ynh_add_config --template="gunicorn.conf.py" --destination="$install_dir/gunicorn.conf.py" -ynh_add_config --template="manage.py" --destination="$final_path/manage.py" -chmod +x "$final_path/manage.py" +ynh_add_config --template="manage.py" --destination="$install_dir/manage.py" +chmod +x "$install_dir/manage.py" -ynh_add_config --template="settings.py" --destination="$final_path/settings.py" -ynh_add_config --template="setup_user.py" --destination="$final_path/setup_user.py" -ynh_add_config --template="urls.py" --destination="$final_path/urls.py" -ynh_add_config --template="wsgi.py" --destination="$final_path/wsgi.py" +ynh_add_config --template="settings.py" --destination="$install_dir/settings.py" +ynh_add_config --template="setup_user.py" --destination="$install_dir/setup_user.py" +ynh_add_config --template="urls.py" --destination="$install_dir/urls.py" +ynh_add_config --template="wsgi.py" --destination="$install_dir/wsgi.py" -touch "$final_path/local_settings.py" +touch "$install_dir/local_settings.py" #================================================= # MIGRATE / COLLECTSTATIC / CREATEADMIN #================================================= ynh_script_progression --message="migrate/collectstatic/createadmin..." --weight=10 -cd "$final_path" || exit +pushd "$install_dir" + # Just for debugging: + ynh_exec_as "$app" "$venvpython" ./manage.py diffsettings -# Just for debugging: -./manage.py diffsettings + ynh_exec_as "$app" "$venvpython" ./manage.py migrate --no-input + ynh_exec_as "$app" "$venvpython" ./manage.py collectstatic --no-input -./manage.py migrate --no-input -./manage.py collectstatic --no-input - -# Create/update Django superuser (set unusable password, because auth done via SSOwat): -./manage.py create_superuser --username="$admin" --email="$(ynh_user_get_info "$admin" mail)" - -# Check the configuration -# This may fail in some cases with errors, etc., but the app works and the user can fix issues later. -./manage.py check --deploy || true + # Create/update Django superuser (set unusable password, because auth done via SSOwat): + ynh_exec_as "$app" "$venvpython" ./manage.py create_superuser --username="$admin" --email="$(ynh_user_get_info "$admin" mail)" + # Check the configuration + # This may fail in some cases with errors, etc., but the app works and the user can fix issues later. + ynh_exec_as "$app" "$venvpython" ./manage.py check --deploy || true +popd #================================================= -# SETUP LOGROTATE +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring log rotation..." +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 + +# Create a dedicated nginx config +ynh_add_nginx_config + +# Create a dedicated systemd config +ynh_add_systemd_config --service="$app" --template="systemd.service" +yunohost service add "$app" --description="$app service" --log="/var/log/$app/$app.log" # Use logrotate to manage app-specific logfile(s) -ynh_use_logrotate "$log_file" - -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --log="${log_file}" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -# Set permissions to app files -chown -R "$app:" "$log_path" -chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" - -chmod o-rwx "$log_path" -chmod o-rwx "$public_path" -chmod o-rwx "$final_path" - -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring systemd service '$app'..." --weight=5 - -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/systemd -ynh_add_systemd_config --service="$app" --template="systemd.service" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring SSOwat..." - -# Make app public if necessary or protect it -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - ynh_permission_update --permission "main" --add "visitors" -fi +ynh_use_logrotate #================================================= # Start the app server via systemd @@ -234,13 +112,6 @@ ynh_script_progression --message="Starting systemd service '$app'..." --weight=5 ynh_systemd_action --service_name="$app" --action="start" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading nginx web server..." - -ynh_systemd_action --service_name="nginx" --action="reload" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index dc573b8..cd3c54c 100755 --- a/scripts/remove +++ b/scripts/remove @@ -10,92 +10,22 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -domain=$(ynh_app_setting_get --app="$app" --key=domain) -db_name=$(ynh_app_setting_get --app="$app" --key=db_name) -db_user=$db_name -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE SERVICE FROM ADMIN PANEL +# REMOVE SYSTEM CONFIGURATIONS #================================================= +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove a service from the admin panel, added by `yunohost service add` -if yunohost service status "$app" >/dev/null 2>&1 -then - ynh_script_progression --message="Removing $app service integration..." - yunohost service remove "$app" +if yunohost service status "$app" >/dev/null 2>&1; then + yunohost service remove "$app" fi -#================================================= -# STOP PYINVENTORY'S SERVICES -#================================================= -ynh_script_progression --message="Stopping and removing systemd service '$app'..." --weight=5 +ynh_remove_logrotate ynh_remove_systemd_config --service="$app" -#================================================= -# REMOVE THE PostgreSQL DATABASE -#================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." - -# Remove a database if it exists, along with the associated user -ynh_psql_remove_db --db_user=$db_user --db_name=$db_name - -##================================================= -## REMOVE REDIS DB -##================================================= - -ynh_redis_remove_db - -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=10 - -# Remove metapackage and its dependencies -ynh_exec_warn_less ynh_remove_app_dependencies - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." - -# Remove the app directory securely -ynh_secure_remove --file="$public_path" -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing nginx web server configuration..." - -# Remove the dedicated nginx config ynh_remove_nginx_config -#================================================= -# REMOVE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Removing logrotate configuration..." - -# Remove the app-specific logrotate config -ynh_remove_logrotate - -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." - -# Delete a system user -ynh_system_user_delete --username="$app" +ynh_redis_remove_db "$redis_db" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index a72837e..7b32ed1 100755 --- a/scripts/restore +++ b/scripts/restore @@ -9,165 +9,57 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading settings..." - -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -db_name=$(ynh_app_setting_get --app="$app" --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) - -domain=$(ynh_app_setting_get --app="$app" --key=domain) -path_url=$(ynh_app_setting_get --app="$app" --key=path) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring $app main directory..." +ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" -ynh_restore_file --origin_path="$public_path" +ynh_restore_file --origin_path="$install_dir" + +chmod o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= -# RECREATE THE DEDICATED USER +# RESTORE THE POSTGRES DATABASE #================================================= -ynh_script_progression --message="Recreating the dedicated system user..." +ynh_script_progression --message="Restoring the Postgresql database..." --weight=1 -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" --use_shell - -#================================================= -# RESTORE USER RIGHTS -#================================================= - -# Restore permissions on app files -chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" - -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=20 - -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" +ynh_psql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql #================================================= # PYTHON VIRTUALENV -# Maybe the backup contains a other Python version #================================================= -ynh_script_progression --message="Recreate Python virtualenv..." --weight=5 +ynh_script_progression --message="Update Python virtualenv..." --weight=5 -# Always recreate everything fresh with current python version -ynh_secure_remove "${final_path}/venv" - -# Skip pip because of: https://github.com/YunoHost/issues/issues/1960 -python3 -m venv --without-pip "${final_path}/venv" -chown -R "$app:" "$final_path" +python3 -m venv --upgrade --without-pip "$install_dir/venv" #================================================= -# PIP INSTALLATION +# RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Install project via pip..." --weight=45 -#run source in a 'sub shell' -( - set +o nounset - source "${final_path}/venv/bin/activate" - set -o nounset - ynh_exec_as $app $final_path/venv/bin/python3 -m ensurepip - ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade wheel pip setuptools - ynh_exec_as $app $final_path/venv/bin/pip3 install --no-deps -r "$final_path/requirements.txt" -) +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 -#================================================= -# RESTORE THE PostgreSQL DATABASE -#================================================= -ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=5 - -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user="$db_user" --db_name="$db_name" --db_pwd="$db_pwd" -ynh_psql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql - -#================================================= -# RESTORE SYSTEMD -#================================================= -ynh_script_progression --message="Restoring the systemd configuration..." +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable $app.service --quiet +systemctl enable "$app.service" --quiet +yunohost service add "$app" --description="$app service" --log="/var/log/$app/$app.log" -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --log="${log_file}" - -#================================================= -# RESTORE THE LOGROTATE CONFIGURATION -#================================================= - -mkdir -p "$log_path" -touch "${log_file}" -chown -R "$app:" "$log_path" ynh_restore_file --origin_path="/etc/logrotate.d/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -# Set permissions to app files -chown -R "$app:" "$log_path" -chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" - -chmod o-rwx "$log_path" -chmod o-rwx "$public_path" -chmod o-rwx "$final_path" +ynh_restore_file --origin_path="/var/log/$app/" +chmod o-rwx "/var/log/$app" +chown -R "$app:" "/var/log/$app" #================================================= # GENERIC FINALIZATION #================================================= -# START PYINVENTORY +# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE #================================================= -ynh_script_progression --message="Starting systemd service '$app'..." --weight=5 +ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 -ynh_systemd_action --service_name="$app" --action="start" +ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading nginx web server..." - -ynh_systemd_action --service_name="nginx" --action="reload" +ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index 9bdc8f1..01e9127 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -8,66 +8,31 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS +# STANDARD UPGRADE STEPS #================================================= -ynh_script_progression --message="Loading installation settings..." - -admin=$(ynh_app_setting_get --app="$app" --key=admin) -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -log_path=$(ynh_app_setting_get --app="$app" --key=log_path) - -domain=$(ynh_app_setting_get --app="$app" --key=domain) -path_url=$(ynh_app_setting_get --app="$app" --key=path) - -port=$(ynh_app_setting_get --app="$app" --key=port) - -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) -db_name=$(ynh_sanitize_dbid --db_name="$app") -db_user=$db_name - -redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) - -#------------------------------------------------- -# config_panel.toml settings: - -debug_enabled=$(ynh_app_setting_get --app="$app" --key=debug_enabled) -if [ -z "$debug_enabled" ]; then - debug_enabled="0" - ynh_app_setting_set --app="$app" --key=debug_enabled --value="$debug_enabled" -fi - -log_level=$(ynh_app_setting_get --app="$app" --key=log_level) -if [ -z "$log_level" ]; then - log_level="WARNING" - ynh_app_setting_set --app="$app" --key=log_level --value="$log_level" -fi - -admin_email=$(ynh_app_setting_get --app="$app" --key=admin_email) -if [ -z "$admin_email" ]; then - admin_email="${admin}@${domain}" - ynh_app_setting_set --app="$app" --key=admin_email --value="$admin_email" -fi - -default_from_email=$(ynh_app_setting_get --app="$app" --key=default_from_email) -if [ -z "$default_from_email" ]; then - default_from_email="${app}@${domain}" - ynh_app_setting_set --app="$app" --key=default_from_email --value="$default_from_email" -fi - +# ENSURE DOWNWARD COMPATIBILITY #================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=40 +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors +if [ -z "${debug_enabled:-}" ]; then + debug_enabled="0" + ynh_app_setting_set --app="$app" --key=debug_enabled --value="$debug_enabled" +fi + +if [ -z "${log_level:-}" ]; then + log_level="WARNING" + ynh_app_setting_set --app="$app" --key=log_level --value="$log_level" +fi + +if [ -z "${admin_email:-}" ]; then + admin_email="${admin}@${domain}" + ynh_app_setting_set --app="$app" --key=admin_email --value="$admin_email" +fi + +if [ -z "${default_from_email:-}" ]; then + default_from_email="${app}@${domain}" + ynh_app_setting_set --app="$app" --key=default_from_email --value="$default_from_email" +fi #================================================= # STANDARD UPGRADE STEPS @@ -76,135 +41,69 @@ ynh_abort_if_errors #================================================= ynh_script_progression --message="Stopping systemd service '$app'..." --weight=5 -ynh_systemd_action --service_name="$app" --action="stop" - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading nginx web server configuration..." - -# Create a dedicated nginx config -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/nginx -ynh_add_nginx_config "public_path" "port" - -#================================================= -# SPECIFIC UPGRADE -#================================================= -# Update dependencies -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=20 - -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." - -# Create a system user -ynh_system_user_create --username="$app" --home_dir="$final_path" --use_shell - -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring systemd service '$app'..." --weight=5 - -ynh_add_systemd_config --service="$app" --template="systemd.service" - -#================================================= -# PYTHON VIRTUALENV -#================================================= -ynh_script_progression --message="Recreate Python virtualenv..." --weight=5 - -# Always recreate everything fresh with current python version -ynh_secure_remove "${final_path}/venv" - -# Skip pip because of: https://github.com/YunoHost/issues/issues/1960 -python3 -m venv --without-pip "${final_path}/venv" - -cp ../conf/requirements.txt "$final_path/requirements.txt" -chown -R "$app:" "$final_path" +ynh_systemd_action --service_name="$app" --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # PIP INSTALLATION #================================================= -ynh_script_progression --message="Install project via pip..." --weight=45 -#run source in a 'sub shell' -( - set +o nounset - source "${final_path}/venv/bin/activate" - set -o nounset - ynh_exec_as $app $final_path/venv/bin/python3 -m ensurepip - ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade wheel pip setuptools - ynh_exec_as $app $final_path/venv/bin/pip3 install --no-deps -r "$final_path/requirements.txt" -) +ynh_script_progression --message="Installing project via pip..." --weight=45 + +# Always recreate everything fresh with current python version +ynh_secure_remove "$install_dir/venv" + +_install_fmd_venv + +chmod o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # copy config files # ================================================ -ynh_script_progression --message="Create project configuration files..." +ynh_script_progression --message="Create $app configuration files..." -ynh_add_config --template="gunicorn.conf.py" --destination="$final_path/gunicorn.conf.py" +ynh_add_config --template="gunicorn.conf.py" --destination="$install_dir/gunicorn.conf.py" -ynh_add_config --template="manage.py" --destination="$final_path/manage.py" -chmod +x "$final_path/manage.py" +ynh_add_config --template="manage.py" --destination="$install_dir/manage.py" +chmod +x "$install_dir/manage.py" -ynh_add_config --template="settings.py" --destination="$final_path/settings.py" -ynh_add_config --template="setup_user.py" --destination="$final_path/setup_user.py" -ynh_add_config --template="urls.py" --destination="$final_path/urls.py" -ynh_add_config --template="wsgi.py" --destination="$final_path/wsgi.py" +ynh_add_config --template="settings.py" --destination="$install_dir/settings.py" +ynh_add_config --template="setup_user.py" --destination="$install_dir/setup_user.py" +ynh_add_config --template="urls.py" --destination="$install_dir/urls.py" +ynh_add_config --template="wsgi.py" --destination="$install_dir/wsgi.py" #================================================= # MIGRATE PYINVENTORY #================================================= ynh_script_progression --message="migrate/collectstatic/createadmin..." --weight=10 -cd "$final_path" || exit +pushd "$install_dir" + # Just for debugging: + ynh_exec_as "$app" "$venvpython" ./manage.py diffsettings -# Just for debugging: -./manage.py diffsettings + ynh_exec_as "$app" "$venvpython" ./manage.py migrate --no-input + ynh_exec_as "$app" "$venvpython" ./manage.py collectstatic --no-input -./manage.py migrate --no-input -./manage.py collectstatic --no-input - -# Create/update Django superuser (set unusable password, because auth done via SSOwat): -./manage.py create_superuser --username="$admin" --email="$(ynh_user_get_info "$admin" mail)" - -# Check the configuration -# This may fail in some cases with errors, etc., but the app works and the user can fix issues later. -./manage.py check --deploy || true + # Create/update Django superuser (set unusable password, because auth done via SSOwat): + ynh_exec_as "$app" "$venvpython" ./manage.py create_superuser --username="$admin" --email="$(ynh_user_get_info "$admin" mail)" + # Check the configuration + # This may fail in some cases with errors, etc., but the app works and the user can fix issues later. + ynh_exec_as "$app" "$venvpython" ./manage.py check --deploy || true +popd #================================================= -# SETUP LOGROTATE +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading logrotate configuration..." +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 + +ynh_add_nginx_config + +ynh_add_systemd_config --service="$app" --template="systemd.service" +yunohost service add "$app" --description="$app service" --log="/var/log/$app/$app.log" -# Use logrotate to manage app-specific logfile(s) ynh_use_logrotate --non-append - -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --log="${log_file}" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -# Set permissions to app files -chown -R "$app:" "$log_path" -chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" - -chmod o-rwx "$log_path" -chmod o-rwx "$public_path" -chmod o-rwx "$final_path" +chmod o-rwx "/var/log/$app" +chown -R "$app:" "/var/log/$app" #================================================= # Start the app server via systemd @@ -213,13 +112,6 @@ ynh_script_progression --message="Starting systemd service '$app'..." --weight=5 ynh_systemd_action --service_name="$app" --action="start" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading nginx web server..." - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..953b195 --- /dev/null +++ b/tests.toml @@ -0,0 +1,9 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------