django-fmd_ynh/README_fr.md

django-fmd pour YunoHost

Read this readme in english.

Ce package vous permet d'installer django-fmd rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, regardez ici pour savoir comment l'installer et en profiter.

Vue d'ensemble

Find My Device Server implemented in Python using Django. Usable for the Andorid App FindMyDevice by Nnulide:

Pull requests welcome ;)

This package for YunoHost used django-yunohost-integration

Version incluse : 0.1.0~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:

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. By default the YunoHost admin is inserted here. To check current ADMINS run:

(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:

echo "ADMINS = (('Your Name', 'example@domain.tld'),)" >> /opt/yunohost/django-fmd/local_settings.py

To check the effective settings, run this:

(venv) root@yunohost:/opt/yunohost/django-fmd# ./manage.py diffsettings

Miscellaneous

SSO authentication

SSOwat is fully supported via 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.:

sudo yunohost app remove django-fmd

Backup / remove / restore cycle, e.g.:

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.:

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.:

~$ 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 : https://gitlab.com/jedie/django-find-my-device
• Dépôt de code officiel de l'app : https://gitlab.com/jedie/django-find-my-device
• Documentation YunoHost pour cette app : https://yunohost.org/app_django-fmd
• Signaler un bug : https://github.com/YunoHost-Apps/django-fmd_ynh/issues

Informations pour les développeurs

Merci de faire vos pull request sur la branche testing.

Pour essayer la branche testing, procédez comme suit.

sudo yunohost app install https://github.com/YunoHost-Apps/django-fmd_ynh/tree/testing --debug
ou
sudo yunohost app upgrade django-fmd -u https://github.com/YunoHost-Apps/django-fmd_ynh/tree/testing --debug

Plus d'infos sur le packaging d'applications : https://yunohost.org/packaging_apps