django-for-runners_ynh/README.md
JensDiemer 94fc74cc02 init
2020-12-12 19:38:58 +01:00

5.6 KiB

Django-For-Runners for YunoHost

Integration level
Install Django-For-Runners with YunoHost

This package allows you to install Django-For-Runners quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Current status is pre-alpha: This app doesn't work, yet ;)

Pull requests welcome ;)

Overview

Django-For-Runners is a libre web-based management to catalog things including state and location etc. using Python/Django.

Screenshots

Admin account

An admin user is created at installation, the login is what you provided at installation, the password is django-for-runners.

Settings and upgrades

Almost everything related to Django-For-Runners's configuration is handled in a "../conf/ynh_for_runners_settings.py" file. You can edit the file $final_path/local_settings.py to enable or disable features.

Miscellaneous

LDAP connection

Supported by https://github.com/django-auth-ldap/django-auth-ldap


Developer info

package installation / debugging

Please send your pull request to https://github.com/YunoHost-Apps/django-for-runners_ynh

Try 'main' branch, e.g.:

sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug
or
sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug

Try 'testing' branch, e.g.:

sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug
or
sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug

To remove call e.g.:

sudo yunohost app remove django-for-runners

Debug installation, e.g.:

root@yunohost:~# ls -la /var/www/django-for-runners/
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-for-runners/
total 58
drwxr-xr-x 5 django-for-runners django-for-runners   11 Dec  8 08:39 .
drwxr-xr-x 3 root        root           3 Dec  8 08:36 ..
-rw-r--r-- 1 django-for-runners django-for-runners  460 Dec  8 08:39 gunicorn.conf.py
-rw-r--r-- 1 django-for-runners django-for-runners    0 Dec  8 08:39 local_settings.py
-rwxr-xr-x 1 django-for-runners django-for-runners  274 Dec  8 08:39 manage.py
-rw-r--r-- 1 django-for-runners django-for-runners  171 Dec  8 08:39 secret.txt
drwxr-xr-x 6 django-for-runners django-for-runners    6 Dec  8 08:37 venv
-rw-r--r-- 1 django-for-runners django-for-runners  115 Dec  8 08:39 wsgi.py
-rw-r--r-- 1 django-for-runners django-for-runners 4737 Dec  8 08:39 ynh_for_runners_settings.py

root@yunohost:~# cd /opt/yunohost/django-for-runners/
root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate
(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py check
Django-For-Runners v0.12.0rc2 (Django v2.2.17)
DJANGO_SETTINGS_MODULE='ynh_django-for-runners_settings'
PROJECT_PATH:/opt/yunohost/django-for-runners/venv/lib/python3.7/site-packages
BASE_PATH:/opt/yunohost/django-for-runners
System check identified no issues (0 silenced).

root@yunohost:~# tail -f /var/log/django-for-runners/django-for-runners.log
root@yunohost:~# cat /etc/systemd/system/django-for-runners.service

root@yunohost:~# systemctl reload-or-restart django-for-runners
root@yunohost:~# journalctl --unit=django-for-runners --follow

local test

For quicker developing of Django-For-Runners in the context of YunoHost app, it's possible to run the Django developer server with the settings and urls made for YunoHost installation.

For this, just run local_test.py in a Django-For-Runners virtualenv.

e.g.:

~$ git clone https://github.com/jedie/Django-For-Runners.git
~$ git clone https://github.com/YunoHost-Apps/django-for-runners_ynh.git
~$ cd Django-For-Runners/
~/Django-For-Runners$ make install
~/Django-For-Runners$ poetry shell
(django-for-runners-yd_5sxYx-py3.8) ~/Django-For-Runners$ cd ../django-for-runners_ynh/
(django-for-runners-yd_5sxYx-py3.8) ~/django-for-runners_ynh$ ./local_test.py
...
Django version 2.2.17, using settings 'ynh_django-for-runners_settings'
Starting development server at http://127.0.0.1:8000/

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/