diff --git a/README.md b/README.md index dce3626..6aa255a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Vikunja for YunoHost -[![Integration level](https://dash.yunohost.org/integration/vikunja.svg)](https://dash.yunohost.org/appci/app/vikunja) ![](https://ci-apps.yunohost.org/ci/badges/vikunja.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vikunja.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/vikunja.svg)](https://dash.yunohost.org/appci/app/vikunja) ![Working status](https://ci-apps.yunohost.org/ci/badges/vikunja.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/vikunja.maintain.svg) [![Install Vikunja with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vikunja) *[Lire ce readme en français.](./README_fr.md)* @@ -32,7 +32,7 @@ Vikunja is a self-hosted open-source to-do list application for all platforms. ## Screenshots -![](./doc/screenshots/kanban.png) +![Screenshot of Vikunja](./doc/screenshots/kanban.png) ## Disclaimers / important information @@ -44,21 +44,22 @@ You can also configure Vikunja by editing this file `/opt/vikunja/config.yml` us The API is accesible with this path: https://domain.ltd/api/v1/docs ## Documentation and resources -* Official app website: https://vikunja.io/ -* Official admin documentation: https://vikunja.io/docs/ -* Upstream app code repository: https://kolaente.dev/vikunja/ -* YunoHost documentation for this app: https://yunohost.org/app_vikunja -* Report a bug: https://github.com/YunoHost-Apps/vikunja_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/vikunja_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/vikunja_ynh/tree/testing --debug or sudo yunohost app upgrade vikunja -u https://github.com/YunoHost-Apps/vikunja_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 4754089..fe6e45c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Vikunja pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/vikunja.svg)](https://dash.yunohost.org/appci/app/vikunja) ![](https://ci-apps.yunohost.org/ci/badges/vikunja.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vikunja.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/vikunja.svg)](https://dash.yunohost.org/appci/app/vikunja) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/vikunja.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/vikunja.maintain.svg) [![Installer Vikunja avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vikunja) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Vikunja 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.* @@ -28,7 +32,7 @@ Vikunja est une application de liste de tâches Open Source auto-hébergée pour ## Captures d'écran -![](./doc/screenshots/kanban.png) +![Capture d'écran de Vikunja](./doc/screenshots/kanban.png) ## Avertissements / informations importantes @@ -37,21 +41,22 @@ Vikunja est une application de liste de tâches Open Source auto-hébergée pour Vous pouvez configurer Vikunja en modifiant le fichier `/opt/vikunja/config.yml` en vous aidant de la [documentation](https://vikunja.io/docs/config-options/). ## Documentations et ressources -* Site officiel de l'app : https://vikunja.io/ -* Documentation officielle de l'admin : https://vikunja.io/docs/ -* Dépôt de code officiel de l'app : https://kolaente.dev/vikunja/ -* Documentation YunoHost pour cette app : https://yunohost.org/app_vikunja -* Signaler un bug : https://github.com/YunoHost-Apps/vikunja_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/vikunja_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/vikunja_ynh/tree/testing --debug ou sudo yunohost app upgrade vikunja -u https://github.com/YunoHost-Apps/vikunja_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** diff --git a/check_process b/check_process index 518c46a..533b89c 100644 --- a/check_process +++ b/check_process @@ -15,7 +15,7 @@ upgrade=1 upgrade=1 from_commit=b7c5209ca080054e8777c1882f4bf54851834270 backup_restore=1 - multi_instance=1 + multi_instance=0 change_url=1 ;;; Options Email= diff --git a/conf/config.yml b/conf/config.yml index f80e62e..9ecd451 100644 --- a/conf/config.yml +++ b/conf/config.yml @@ -98,19 +98,19 @@ cors: mailer: # Whether to enable the mailer or not. If it is disabled, all users are enabled right away and password reset is not possible. - enabled: false + enabled: true # SMTP Host - host: "" + host: "localhost" # SMTP Host port - port: 587 + port: 25 # SMTP username - username: "user" + username: "" # SMTP password password: "" # Wether to skip verification of the tls certificate on the server - skiptlsverify: false + skiptlsverify: true # The default from address when sending emails - fromemail: "mail@vikunja" + fromemail: "vikunja@__DOMAIN__" # The length of the mail queue. queuelength: 100 # The timeout in seconds after which the current open connection to the mailserver will be closed. diff --git a/conf/systemd.service b/conf/systemd.service index 8f38aa5..adf2e25 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -7,8 +7,8 @@ Requires=postgresql.service redis.service Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=/opt/vikunja -ExecStart=/opt/vikunja/vikunja +WorkingDirectory=/opt/__APP__ +ExecStart=/opt/__APP__/vikunja RestartSec=2s Restart=always diff --git a/scripts/backup b/scripts/backup index f876c34..146898e 100644 --- a/scripts/backup +++ b/scripts/backup @@ -40,10 +40,10 @@ ynh_print_info --message="Declaring files to be backed up..." ynh_backup --src_path="$final_path" # Config -ynh_backup --src_path="/etc/vikunja/config.yml" +ynh_backup --src_path="/etc/$app/config.yml" # Backend -ynh_backup --src_path="/opt/vikunja" +ynh_backup --src_path="/opt/$app" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 094fe89..4fefeca 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -117,9 +117,9 @@ ynh_script_progression --message="Adding a configuration file..." --weight=1 domain="$new_domain" path="$new_path" redis_db=$(ynh_redis_get_free_db) -ynh_add_config --template="../conf/config.yml" --destination="/etc/vikunja/config.yml" +ynh_add_config --template="../conf/config.yml" --destination="/etc/$app/config.yml" -chmod 600 "/etc/vikunja/config.yml" +chmod 600 "/etc/$app/config.yml" #================================================= # GENERIC FINALISATION diff --git a/scripts/install b/scripts/install index 8b46920..0acd0ea 100644 --- a/scripts/install +++ b/scripts/install @@ -25,7 +25,6 @@ path_url="/" is_public=$YNH_APP_ARG_IS_PUBLIC timezone="$(cat /etc/timezone)" secret=$(ynh_string_random --length=32) -architecture=$YNH_ARCH app=$YNH_APP_INSTANCE_NAME @@ -109,15 +108,15 @@ chown -R $app:www-data "$final_path" ynh_script_progression --message="Setting up backend..." --weight=1 # Download, check integrity, uncompress and patch the source from app.src -mkdir -p "/opt/vikunja" -mkdir -p "/opt/vikunja/files" +mkdir -p "/opt/$app" +mkdir -p "/opt/$app/files" tempdir="$(mktemp -d)" -ynh_setup_source --dest_dir=$tempdir --source_id="$architecture" +ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH back="$(find $tempdir -name "vikunja-*" \! -name "*.sha256")" -cp "$back" "/opt/vikunja/vikunja" +cp "$back" "/opt/$app/vikunja" -chmod +x "/opt/vikunja/vikunja" -chown -R $app:www-data "/opt/vikunja/files" +chmod +x "/opt/$app/vikunja" +chown -R $app:www-data "/opt/$app/files" #================================================= # NGINX CONFIGURATION @@ -132,12 +131,12 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Adding a configuration file..." --weight=1 -mkdir -p "/etc/vikunja" +mkdir -p "/etc/$app" redis_db=$(ynh_redis_get_free_db) -ynh_add_config --template="../conf/config.yml" --destination="/etc/vikunja/config.yml" +ynh_add_config --template="../conf/config.yml" --destination="/etc/$app/config.yml" -chmod 400 "/etc/vikunja/config.yml" -chown $app:$app "/etc/vikunja/config.yml" +chmod 400 "/etc/$app/config.yml" +chown $app:$app "/etc/$app/config.yml" #================================================= # SETUP SYSTEMD diff --git a/scripts/remove b/scripts/remove index 23189e4..049da87 100644 --- a/scripts/remove +++ b/scripts/remove @@ -98,7 +98,7 @@ ynh_system_user_delete --username=$app ynh_script_progression --message="Removing backend..." --weight=1 # Delete /opt/vikunja -ynh_secure_remove --file="/opt/vikunja" +ynh_secure_remove --file="/opt/$app" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 90f666b..5c14c96 100644 --- a/scripts/restore +++ b/scripts/restore @@ -66,12 +66,12 @@ chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" # Config -ynh_restore_file --origin_path="/etc/vikunja/config.yml" +ynh_restore_file --origin_path="/etc/$app/config.yml" # Backend -ynh_restore_file --origin_path="/opt/vikunja" -chmod +x "/opt/vikunja/vikunja" -chown -R $app:www-data "/opt/vikunja/files" +ynh_restore_file --origin_path="/opt/$app" +chmod +x "/opt/$app/vikunja" +chown -R $app:www-data "/opt/$app/files" #================================================= # REINSTALL DEPENDENCIES diff --git a/scripts/upgrade b/scripts/upgrade index 8ad7751..cde8496 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -25,7 +25,6 @@ db_user=$db_name db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) timezone="$(cat /etc/timezone)" secret=$(ynh_string_random --length=32) -architecture=$YNH_ARCH set_motd=$(ynh_app_setting_get --app=$app --key=set_motd) enable_registration=$(ynh_app_setting_get --app=$app --key=enable_registration) @@ -104,21 +103,21 @@ then # Download, check integrity, uncompress and patch the source from app.src # Frontend - ynh_setup_source --dest_dir="$final_path" --source_id="front" --keep="/etc/vikunja/config.yml" + ynh_setup_source --dest_dir="$final_path" --source_id="front" --keep="/etc/$app/config.yml" # Backend - mkdir -p "/opt/vikunja/files" + mkdir -p "/opt/$app/files" tempdir="$(mktemp -d)" - ynh_setup_source --dest_dir=$tempdir --source_id="$architecture" + ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH back="$(find $tempdir -name "vikunja-*" \! -name "*.sha256")" - cp "$back" "/opt/vikunja/vikunja" + cp "$back" "/opt/$app/vikunja" fi chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" -chmod +x "/opt/vikunja/vikunja" -chown -R $app:www-data "/opt/vikunja/files" +chmod +x "/opt/$app/vikunja" +chown -R $app:www-data "/opt/$app/files" #================================================= # NGINX CONFIGURATION