mirror of
https://github.com/YunoHost-Apps/django-fritzconnection_ynh.git
synced 2024-09-03 18:26:24 +02:00
Auto-update README
This commit is contained in:
parent
4b0799f31d
commit
7ae4116565
5 changed files with 409 additions and 23 deletions
6
ALL_README.md
Normal file
6
ALL_README.md
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
# All available README files by language
|
||||||
|
|
||||||
|
- [Read the README in English](README.md)
|
||||||
|
- [Lire le README en français](README_fr.md)
|
||||||
|
- [Le o README en galego](README_gl.md)
|
||||||
|
- [Leggi il “README” in italiano](README_it.md)
|
18
README.md
18
README.md
|
@ -1,5 +1,5 @@
|
||||||
<!--
|
<!--
|
||||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
It shall NOT be edited by hand.
|
It shall NOT be edited by hand.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
|
||||||
|
|
||||||
[![Install django-fritzconnection with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
|
[![Install django-fritzconnection with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Read this README is other languages.](./ALL_README.md)*
|
||||||
|
|
||||||
> *This package allows you to install django-fritzconnection quickly and simply on a YunoHost server.
|
> *This package allows you to install django-fritzconnection quickly and simply on a YunoHost server.*
|
||||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
@ -171,15 +171,15 @@ Notes:
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Upstream app code repository: <https://github.com/jedie/django-fritzconnection>
|
- Upstream app code repository: <https://github.com/jedie/django-fritzconnection>
|
||||||
* YunoHost Store: <https://apps.yunohost.org/app/django-fritzconnection>
|
- YunoHost Store: <https://apps.yunohost.org/app/django-fritzconnection>
|
||||||
* Report a bug: <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
|
- Report a bug: <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the `testing` branch, please proceed like that:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
|
|
24
README_fr.md
24
README_fr.md
|
@ -1,6 +1,6 @@
|
||||||
<!--
|
<!--
|
||||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
It shall NOT be edited by hand.
|
Il NE doit PAS être modifié à la main.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# django-fritzconnection pour YunoHost
|
# django-fritzconnection pour YunoHost
|
||||||
|
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
|
||||||
|
|
||||||
[![Installer django-fritzconnection avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
|
[![Installer django-fritzconnection avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Lire le README dans d'autres langues.](./ALL_README.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d’installer django-fritzconnection rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d’installer django-fritzconnection rapidement et simplement sur un serveur YunoHost.*
|
||||||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
|
||||||
|
|
||||||
## Vue d’ensemble
|
## Vue d’ensemble
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ Pull requests welcome ;)
|
||||||
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
|
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
|
||||||
|
|
||||||
|
|
||||||
**Version incluse :** 0.2.0~ynh2
|
**Version incluse :** 0.2.0~ynh2
|
||||||
|
|
||||||
## Captures d’écran
|
## Captures d’écran
|
||||||
|
|
||||||
|
@ -171,15 +171,15 @@ Notes:
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Dépôt de code officiel de l’app : <https://github.com/jedie/django-fritzconnection>
|
- Dépôt de code officiel de l’app : <https://github.com/jedie/django-fritzconnection>
|
||||||
* YunoHost Store: <https://apps.yunohost.org/app/django-fritzconnection>
|
- YunoHost Store : <https://apps.yunohost.org/app/django-fritzconnection>
|
||||||
* Signaler un bug : <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
|
- Signaler un bug : <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
|
Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
|
||||||
|
|
||||||
Pour essayer la branche testing, procédez comme suit.
|
Pour essayer la branche `testing`, procédez comme suit :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
|
@ -187,4 +187,4 @@ ou
|
||||||
sudo yunohost app upgrade django-fritzconnection -u https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
sudo yunohost app upgrade django-fritzconnection -u https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||||
|
|
190
README_gl.md
Normal file
190
README_gl.md
Normal file
|
@ -0,0 +1,190 @@
|
||||||
|
<!--
|
||||||
|
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
|
NON debe editarse manualmente.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# django-fritzconnection para YunoHost
|
||||||
|
|
||||||
|
[![Nivel de integración](https://dash.yunohost.org/integration/django-fritzconnection.svg)](https://dash.yunohost.org/appci/app/django-fritzconnection) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/django-fritzconnection.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/django-fritzconnection.maintain.svg)
|
||||||
|
|
||||||
|
[![Instalar django-fritzconnection con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
|
||||||
|
|
||||||
|
*[Le este README en outros idiomas.](./ALL_README.md)*
|
||||||
|
|
||||||
|
> *Este paquete permíteche instalar django-fritzconnection de xeito rápido e doado nun servidor YunoHost.*
|
||||||
|
> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
|
||||||
|
|
||||||
|
## Vista xeral
|
||||||
|
|
||||||
|
Web based FritzBox management using Python/Django and the great [fritzconnection](https://github.com/kbr/fritzconnection) library.
|
||||||
|
|
||||||
|
The basic idea is to block/unblock Internet access to a group of devices as easily as possible.
|
||||||
|
|
||||||
|
|
||||||
|
[![pytest](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/django-fritzconnection_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/django-fritzconnection_ynh)
|
||||||
|
|
||||||
|
![django-fritzconnection @ PyPi](https://img.shields.io/pypi/v/django-fritzconnection?label=django-fritzconnection%20%40%20PyPi)
|
||||||
|
![Python Versions](https://img.shields.io/pypi/pyversions/django-fritzconnection)
|
||||||
|
![License GPL V3+](https://img.shields.io/pypi/l/django-fritzconnection)
|
||||||
|
|
||||||
|
Pull requests welcome ;)
|
||||||
|
|
||||||
|
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
|
||||||
|
|
||||||
|
|
||||||
|
**Versión proporcionada:** 0.2.0~ynh2
|
||||||
|
|
||||||
|
## Capturas de pantalla
|
||||||
|
|
||||||
|
![Captura de pantalla de django-fritzconnection](./doc/screenshots/screenshot.png)
|
||||||
|
|
||||||
|
## Avisos / información importante
|
||||||
|
|
||||||
|
## Settings and upgrades
|
||||||
|
|
||||||
|
Almost everything related to django-fritzconnection's configuration is handled in a `"../conf/settings.py"` file.
|
||||||
|
You can edit the file `/opt/yunohost/django-fritzconnection/local_settings.py` to enable or disable features.
|
||||||
|
|
||||||
|
Test sending emails:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ssh admin@yourdomain.tld
|
||||||
|
root@yunohost:~# cd /opt/yunohost/django-fritzconnection/
|
||||||
|
root@yunohost:/opt/yunohost/django-fritzconnection# source venv/bin/activate
|
||||||
|
(venv) root@yunohost:/opt/yunohost/django-fritzconnection# ./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-fritzconnection# ./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-fritzconnection/local_settings.py
|
||||||
|
```
|
||||||
|
|
||||||
|
To check the effective settings, run this:
|
||||||
|
```bash
|
||||||
|
(venv) root@yunohost:/opt/yunohost/django-fritzconnection# ./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-fritzconnection
|
||||||
|
```
|
||||||
|
|
||||||
|
Backup / remove / restore cycle, e.g.:
|
||||||
|
```bash
|
||||||
|
yunohost backup create --apps django-fritzconnection
|
||||||
|
yunohost backup list
|
||||||
|
archives:
|
||||||
|
- django-fritzconnection-pre-upgrade1
|
||||||
|
- 20201223-163434
|
||||||
|
yunohost app remove django-fritzconnection
|
||||||
|
yunohost backup restore 20201223-163434 --apps django-fritzconnection
|
||||||
|
```
|
||||||
|
|
||||||
|
Debug installation, e.g.:
|
||||||
|
```bash
|
||||||
|
root@yunohost:~# ls -la /var/www/django-fritzconnection/
|
||||||
|
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-fritzconnection/
|
||||||
|
total 58
|
||||||
|
drwxr-xr-x 5 django-fritzconnection django-fritzconnection 11 Dec 8 08:39 .
|
||||||
|
drwxr-xr-x 3 root root 3 Dec 8 08:36 ..
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 460 Dec 8 08:39 gunicorn.conf.py
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 0 Dec 8 08:39 local_settings.py
|
||||||
|
-rwxr-xr-x 1 django-fritzconnection django-fritzconnection 274 Dec 8 08:39 manage.py
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 171 Dec 8 08:39 secret.txt
|
||||||
|
drwxr-xr-x 6 django-fritzconnection django-fritzconnection 6 Dec 8 08:37 venv
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 115 Dec 8 08:39 wsgi.py
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 4737 Dec 8 08:39 settings.py
|
||||||
|
|
||||||
|
root@yunohost:~# cd /opt/yunohost/django-fritzconnection/
|
||||||
|
root@yunohost:/opt/yunohost/django-fritzconnection# source venv/bin/activate
|
||||||
|
(venv) root@yunohost:/opt/yunohost/django-fritzconnection# ./manage.py check
|
||||||
|
django-fritzconnection v0.8.2 (Django v2.2.17)
|
||||||
|
DJANGO_SETTINGS_MODULE='settings'
|
||||||
|
PROJECT_PATH:/opt/yunohost/django-fritzconnection/venv/lib/python3.7/site-packages
|
||||||
|
BASE_PATH:/opt/yunohost/django-fritzconnection
|
||||||
|
System check identified no issues (0 silenced).
|
||||||
|
|
||||||
|
root@yunohost:~# tail -f /var/log/django-fritzconnection/django-fritzconnection.log
|
||||||
|
root@yunohost:~# cat /etc/systemd/system/django-fritzconnection.service
|
||||||
|
|
||||||
|
root@yunohost:~# systemctl reload-or-restart django-fritzconnection
|
||||||
|
root@yunohost:~# journalctl --unit=django-fritzconnection --follow
|
||||||
|
```
|
||||||
|
|
||||||
|
## local test
|
||||||
|
|
||||||
|
For quicker developing of django-fritzconnection 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-fritzconnection_ynh.git
|
||||||
|
~$ cd django-fritzconnection_ynh/
|
||||||
|
~/django-fritzconnection_ynh$ make
|
||||||
|
install-poetry install or update poetry
|
||||||
|
install install django-fritzconnection via poetry
|
||||||
|
update update the sources and installation
|
||||||
|
local-test Run local_test.py to run django-fritzconnection_ynh locally
|
||||||
|
~/django-fritzconnection_ynh$ make install-poetry
|
||||||
|
~/django-fritzconnection_ynh$ make install
|
||||||
|
~/django-fritzconnection_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/`
|
||||||
|
|
||||||
|
## Documentación e recursos
|
||||||
|
|
||||||
|
- Repositorio de orixe do código: <https://github.com/jedie/django-fritzconnection>
|
||||||
|
- Tenda YunoHost: <https://apps.yunohost.org/app/django-fritzconnection>
|
||||||
|
- Informar dun problema: <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
|
||||||
|
|
||||||
|
## Info de desenvolvemento
|
||||||
|
|
||||||
|
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
|
||||||
|
|
||||||
|
Para probar a rama `testing`, procede deste xeito:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade django-fritzconnection -u https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>
|
190
README_it.md
Normal file
190
README_it.md
Normal file
|
@ -0,0 +1,190 @@
|
||||||
|
<!--
|
||||||
|
N.B.: Questo README è stato automaticamente generato da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
|
NON DEVE essere modificato manualmente.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# django-fritzconnection per YunoHost
|
||||||
|
|
||||||
|
[![Livello di integrazione](https://dash.yunohost.org/integration/django-fritzconnection.svg)](https://dash.yunohost.org/appci/app/django-fritzconnection) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/django-fritzconnection.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/django-fritzconnection.maintain.svg)
|
||||||
|
|
||||||
|
[![Installa django-fritzconnection con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
|
||||||
|
|
||||||
|
*[Leggi questo README in altre lingue.](./ALL_README.md)*
|
||||||
|
|
||||||
|
> *Questo pacchetto ti permette di installare django-fritzconnection su un server YunoHost in modo semplice e veloce.*
|
||||||
|
> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.*
|
||||||
|
|
||||||
|
## Panoramica
|
||||||
|
|
||||||
|
Web based FritzBox management using Python/Django and the great [fritzconnection](https://github.com/kbr/fritzconnection) library.
|
||||||
|
|
||||||
|
The basic idea is to block/unblock Internet access to a group of devices as easily as possible.
|
||||||
|
|
||||||
|
|
||||||
|
[![pytest](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/django-fritzconnection_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/django-fritzconnection_ynh)
|
||||||
|
|
||||||
|
![django-fritzconnection @ PyPi](https://img.shields.io/pypi/v/django-fritzconnection?label=django-fritzconnection%20%40%20PyPi)
|
||||||
|
![Python Versions](https://img.shields.io/pypi/pyversions/django-fritzconnection)
|
||||||
|
![License GPL V3+](https://img.shields.io/pypi/l/django-fritzconnection)
|
||||||
|
|
||||||
|
Pull requests welcome ;)
|
||||||
|
|
||||||
|
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
|
||||||
|
|
||||||
|
|
||||||
|
**Versione pubblicata:** 0.2.0~ynh2
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|
![Screenshot di django-fritzconnection](./doc/screenshots/screenshot.png)
|
||||||
|
|
||||||
|
## Attenzione/informazioni importanti
|
||||||
|
|
||||||
|
## Settings and upgrades
|
||||||
|
|
||||||
|
Almost everything related to django-fritzconnection's configuration is handled in a `"../conf/settings.py"` file.
|
||||||
|
You can edit the file `/opt/yunohost/django-fritzconnection/local_settings.py` to enable or disable features.
|
||||||
|
|
||||||
|
Test sending emails:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ssh admin@yourdomain.tld
|
||||||
|
root@yunohost:~# cd /opt/yunohost/django-fritzconnection/
|
||||||
|
root@yunohost:/opt/yunohost/django-fritzconnection# source venv/bin/activate
|
||||||
|
(venv) root@yunohost:/opt/yunohost/django-fritzconnection# ./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-fritzconnection# ./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-fritzconnection/local_settings.py
|
||||||
|
```
|
||||||
|
|
||||||
|
To check the effective settings, run this:
|
||||||
|
```bash
|
||||||
|
(venv) root@yunohost:/opt/yunohost/django-fritzconnection# ./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-fritzconnection
|
||||||
|
```
|
||||||
|
|
||||||
|
Backup / remove / restore cycle, e.g.:
|
||||||
|
```bash
|
||||||
|
yunohost backup create --apps django-fritzconnection
|
||||||
|
yunohost backup list
|
||||||
|
archives:
|
||||||
|
- django-fritzconnection-pre-upgrade1
|
||||||
|
- 20201223-163434
|
||||||
|
yunohost app remove django-fritzconnection
|
||||||
|
yunohost backup restore 20201223-163434 --apps django-fritzconnection
|
||||||
|
```
|
||||||
|
|
||||||
|
Debug installation, e.g.:
|
||||||
|
```bash
|
||||||
|
root@yunohost:~# ls -la /var/www/django-fritzconnection/
|
||||||
|
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-fritzconnection/
|
||||||
|
total 58
|
||||||
|
drwxr-xr-x 5 django-fritzconnection django-fritzconnection 11 Dec 8 08:39 .
|
||||||
|
drwxr-xr-x 3 root root 3 Dec 8 08:36 ..
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 460 Dec 8 08:39 gunicorn.conf.py
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 0 Dec 8 08:39 local_settings.py
|
||||||
|
-rwxr-xr-x 1 django-fritzconnection django-fritzconnection 274 Dec 8 08:39 manage.py
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 171 Dec 8 08:39 secret.txt
|
||||||
|
drwxr-xr-x 6 django-fritzconnection django-fritzconnection 6 Dec 8 08:37 venv
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 115 Dec 8 08:39 wsgi.py
|
||||||
|
-rw-r--r-- 1 django-fritzconnection django-fritzconnection 4737 Dec 8 08:39 settings.py
|
||||||
|
|
||||||
|
root@yunohost:~# cd /opt/yunohost/django-fritzconnection/
|
||||||
|
root@yunohost:/opt/yunohost/django-fritzconnection# source venv/bin/activate
|
||||||
|
(venv) root@yunohost:/opt/yunohost/django-fritzconnection# ./manage.py check
|
||||||
|
django-fritzconnection v0.8.2 (Django v2.2.17)
|
||||||
|
DJANGO_SETTINGS_MODULE='settings'
|
||||||
|
PROJECT_PATH:/opt/yunohost/django-fritzconnection/venv/lib/python3.7/site-packages
|
||||||
|
BASE_PATH:/opt/yunohost/django-fritzconnection
|
||||||
|
System check identified no issues (0 silenced).
|
||||||
|
|
||||||
|
root@yunohost:~# tail -f /var/log/django-fritzconnection/django-fritzconnection.log
|
||||||
|
root@yunohost:~# cat /etc/systemd/system/django-fritzconnection.service
|
||||||
|
|
||||||
|
root@yunohost:~# systemctl reload-or-restart django-fritzconnection
|
||||||
|
root@yunohost:~# journalctl --unit=django-fritzconnection --follow
|
||||||
|
```
|
||||||
|
|
||||||
|
## local test
|
||||||
|
|
||||||
|
For quicker developing of django-fritzconnection 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-fritzconnection_ynh.git
|
||||||
|
~$ cd django-fritzconnection_ynh/
|
||||||
|
~/django-fritzconnection_ynh$ make
|
||||||
|
install-poetry install or update poetry
|
||||||
|
install install django-fritzconnection via poetry
|
||||||
|
update update the sources and installation
|
||||||
|
local-test Run local_test.py to run django-fritzconnection_ynh locally
|
||||||
|
~/django-fritzconnection_ynh$ make install-poetry
|
||||||
|
~/django-fritzconnection_ynh$ make install
|
||||||
|
~/django-fritzconnection_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/`
|
||||||
|
|
||||||
|
## Documentazione e risorse
|
||||||
|
|
||||||
|
- Repository upstream del codice dell’app: <https://github.com/jedie/django-fritzconnection>
|
||||||
|
- Store di YunoHost: <https://apps.yunohost.org/app/django-fritzconnection>
|
||||||
|
- Segnala un problema: <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
|
||||||
|
|
||||||
|
## Informazioni per sviluppatori
|
||||||
|
|
||||||
|
Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
|
||||||
|
|
||||||
|
Per provare la branch di `testing`, si prega di procedere in questo modo:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
|
o
|
||||||
|
sudo yunohost app upgrade django-fritzconnection -u https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Maggiori informazioni riguardo il pacchetto di quest’app:** <https://yunohost.org/packaging_apps>
|
Loading…
Reference in a new issue