YunoHost-Apps/ihatemoney_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ihatemoney_ynh.git synced 2024-09-03 19:26:15 +02:00
Code Issues Activity Actions

Merge pull request #44 from YunoHost-Apps/testing

Browse source 
Testing
This commit is contained in:
Éric Gaspar 2021-12-22 09:25:36 +01:00 committed by GitHub
commit 0bf30a3463
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 1078 additions and 389 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
.github/ISSUE_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,55 @@
---
name: Bug report
about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently.
---
**How to post a meaningful bug report**
1. *Read this whole template first.*
2. *Determine if you are on the right place:*
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
- *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.*
- *When in doubt, post here and we will figure it out together.*
3. *Delete the italic comments as you write over them below, and remove this guide.*
---
### Describe the bug
*A clear and concise description of what the bug is.*
### Context
- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
- YunoHost version: x.x.x
- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes*
- If yes, please explain:
- Using, or trying to install package version/branch:
- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
### Steps to reproduce
- *If you performed a command from the CLI, the command itself is enough. For example:*
```sh
sudo yunohost app install the_app
```
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
- *If the error occurs in your browser, explain what you did:*
1. *Go to '...'*
2. *Click on '...'*
3. *Scroll down to '...'*
4. *See error*
### Expected behavior
*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
### Logs
*When an operation fails, YunoHost provides a simple way to share the logs.*
- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.*
- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.*
*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)*
*If applicable and useful, add screenshots to help explain your problem.*

16
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,16 @@
## Problem
- *Description of why you made this PR*
## Solution
- *And how do you fix that problem*
## PR Status
- [ ] Code finished and ready to be reviewed/tested
- [ ] The fix/enhancement were manually tested (if applicable)
## Automatic tests
Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)

75
README.md
View file

@ -1,52 +1,61 @@
Yunohost app for « I hate money » budget web app <!--
================================================ 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.
-->
[![Install « I hate money » with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ihatemoney) # I Hate Money for YunoHost
- Supported Yunohost versions : 2.6.x, 2.7.x 3.x [![Integration level](https://dash.yunohost.org/integration/ihatemoney.svg)](https://dash.yunohost.org/appci/app/ihatemoney) ![](https://ci-apps.yunohost.org/ci/badges/ihatemoney.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ihatemoney.maintain.svg)
- Tested Yunohost version : 3.3.1 [![Install I Hate Money with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ihatemoney)
*NB: That means I'll try not to drop support for YunoHost 2.x too soon, and *[Lire ce readme en français.](./README_fr.md)*
accept patches to keep retro-compatibility, but I'll not test it myself against
YunoHost 2.x*
Backs on MySQL database, the identifiers are per-project, not per-user, so no > *This package allows you to install I Hate Money quickly and simply on a YunoHost server.
way to do advanced SSO integration with yunohost accounts. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
The behaviour is either: ## Overview
Simple app to manage your collective expenses
**Shipped version:** 4.1.5~ynh3
**Demo:** https://ihatemoney.org/demo/
## Screenshots
![](./doc/screenshots/screenshot_1_global.webp)
![](./doc/screenshots/screenshot_2_new_operation.webp)
## Disclaimers / important information
* LDAP authentication and Single Sign-on is not supported. The login mechanism in IHateMoney is per-project (not per-user) and therefore can't be integrated in YunoHost.
- **non-public app**: - **non-public app**:
- yunohost login required - yunohost login required
- per-project identifiers required - per-project identifiers required
- any yunohost user with authorized access to the app can create a new - any yunohost user with access to the app can create a new project.
project).
- **public app** : - **public app** :
- no yunohost login required - no yunohost login required
- per-project identifiers required - per-project identifiers required
- any visitor can create a new project. - any visitor can create a new project.
Update ## Documentation and resources
------
To update the app, use: * Official app website: https://github.com/spiral-project/ihatemoney
* Official admin documentation: https://ihatemoney.readthedocs.org/
* Upstream app code repository: https://github.com/spiral-project/ihatemoney
* YunoHost documentation for this app: https://yunohost.org/app_ihatemoney
* Report a bug: https://github.com/YunoHost-Apps/ihatemoney_ynh/issues
`sudo yunohost app upgrade ihatemoney -u https://github.com/YunoHost-Apps/ihatemoney_ynh` ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ihatemoney_ynh/tree/testing).
Maintainer To try the testing branch, please proceed like that.
---------- ```
sudo yunohost app install https://github.com/YunoHost-Apps/ihatemoney_ynh/tree/testing --debug
I rely on or
[ihatemoney official releases](https://github.com/spiral-project/ihatemoney/releases) sudo yunohost app upgrade ihatemoney -u https://github.com/YunoHost-Apps/ihatemoney_ynh/tree/testing --debug
(tarballs). Don't hesitate to pull-request this repo if I missed one :-). ```
Ihatemoney license
------------------
> The code is distributed under a BSD beerware derivative: if you meet the
> people in person and you want to pay them a craft beer, you are highly
> encouraged to do so.
[Full license text](https://github.com/spiral-project/ihatemoney/blob/master/LICENSE)
**More info regarding app packaging:** https://yunohost.org/packaging_apps

57
README_fr.md Normal file
View file

@ -0,0 +1,57 @@
# I Hate Money pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/ihatemoney.svg)](https://dash.yunohost.org/appci/app/ihatemoney) ![](https://ci-apps.yunohost.org/ci/badges/ihatemoney.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ihatemoney.maintain.svg)
[![Installer I Hate Money avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ihatemoney)
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer I Hate Money 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.*
## Vue d'ensemble
Gérez simplement vos dépenses collectives
**Version incluse :** 4.1.5~ynh3
**Démo :** https://ihatemoney.org/demo/
## Captures d'écran
![](./doc/screenshots/screenshot_1_global.webp)
![](./doc/screenshots/screenshot_2_new_operation.webp)
## Avertissements / informations importantes
* L'authentification LDAP et login unifié (SSO) n'est pas supportée. Le mécanisme de connexion sur IHateMoney se fait par projet et ne peut donc pas être intégrée dans YunoHost
- **app non publique**:
- authentification Yunohost requise
- identifiants de projets requis
- Tout utilisateur Yunohost avec accès à l'app peut créer un nouveau projet.
- **app publique** :
- authentification Yunohost non requise
- identifiants de projets requis
- Tout visiteur peut créer un nouveau projet.
## Documentations et ressources
* Site officiel de l'app : https://github.com/spiral-project/ihatemoney
* Documentation officielle de l'admin : https://ihatemoney.readthedocs.org/
* Dépôt de code officiel de l'app : https://github.com/spiral-project/ihatemoney
* Documentation YunoHost pour cette app : https://yunohost.org/app_ihatemoney
* Signaler un bug : https://github.com/YunoHost-Apps/ihatemoney_ynh/issues
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ihatemoney_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/ihatemoney_ynh/tree/testing --debug
ou
sudo yunohost app upgrade ihatemoney -u https://github.com/YunoHost-Apps/ihatemoney_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

29
check_process
View file

@ -1,8 +1,8 @@
;; Full test ;; Full test
; Manifest ; Manifest
domain="domain.tld" (DOMAIN) domain="domain.tld"
path="/path" (PATH) path="/path"
is_public=1 (PUBLIC|public=1|private=0) is_public=1
; Checks ; Checks
pkg_linter=1 pkg_linter=1
setup_sub_dir=1 setup_sub_dir=1
@ -11,23 +11,14 @@
setup_private=1 setup_private=1
setup_public=1 setup_public=1
upgrade=1 upgrade=1
upgrade=1 from_commit=0f904d99367cfec27ec5fe303941fbf1124a7571
backup_restore=1 backup_restore=1
multi_instance=0 multi_instance=1
incorrect_path=1
port_already_use=0 port_already_use=0
change_url=0 change_url=1
;;; Levels
Level 1=auto
Level 2=auto
Level 3=auto
# There is no user concept in ihatemoney
Level 4=1
Level 5=auto
Level 6=auto
Level 7=auto
Level 8=0
Level 9=0
Level 10=0
;;; Options ;;; Options
Email= Email=
Notification=change Notification=none
;;; Upgrade options
; commit=0f904d99367cfec27ec5fe303941fbf1124a7571
name=Before refactoring yunohost package

4
conf/gunicorn.conf.py
View file

@ -2,6 +2,6 @@ backlog = 2048
daemon = False daemon = False
debug = True debug = True
workers = 3 workers = 3
logfile = "/var/log/ihatemoney/budget.gunicorn.log" logfile = "/var/log/__APP__/budget.gunicorn.log"
loglevel = "info" loglevel = "info"
bind = "unix:/tmp/budget.gunicorn.sock" bind = "unix:/tmp/budget.gunicorn___APP__.sock"

8
conf/ihatemoney.cfg
View file

@ -1,10 +1,10 @@
DEBUG = True DEBUG = True
SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://ihatemoney:MY_MYSQL_PW@localhost/ihatemoney' SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__'
SQLACHEMY_ECHO = DEBUG SQLACHEMY_ECHO = DEBUG
SECRET_KEY = "MY_SECRET_KEY" SECRET_KEY = "__SECRET_KEY__"
MAIL_DEFAULT_SENDER = ("Budget manager", "MY_EMAIL") MAIL_DEFAULT_SENDER = ("Budget manager", "__MAILS_SENDER__")
APPLICATION_ROOT='MY_PATH' __SUB_PATH_ONLY__APPLICATION_ROOT='__PATH__'
try: try:
from settings import * from settings import *

11
conf/nginx.conf
View file

@ -1,8 +1,9 @@
location PATHTOCHANGE/static/ { #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
alias /opt/yunohost/ihatemoney/venv/lib/pythonPYTHON_VERSION/site-packages/ihatemoney/static/; location __PATH__/static/ {
alias __PYTHON_VENV_SITE_PACKAGES__/ihatemoney/static/;
} }
location PATHTOCHANGE { location __PATH__/ {
# Force https. # Force usage of https
if ($scheme = http) { if ($scheme = http) {
rewrite ^ https://$server_name$request_uri? permanent; rewrite ^ https://$server_name$request_uri? permanent;
} }
@ -18,7 +19,7 @@ location PATHTOCHANGE {
proxy_busy_buffers_size 32k; proxy_busy_buffers_size 32k;
proxy_intercept_errors on; proxy_intercept_errors on;
if (!-f $request_filename) { if (!-f $request_filename) {
proxy_pass http://unix:/tmp/budget.gunicorn.sock; proxy_pass http://unix:/tmp/budget.gunicorn___APP__.sock;
break; break;
} }

6
conf/supervisord.conf
View file

@ -1,6 +0,0 @@
[program:budget]
command=/opt/yunohost/ihatemoney/venv/bin/gunicorn -c /etc/ihatemoney/gunicorn.conf.py ihatemoney.wsgi:application
user=ihatemoney
autostart=true
autorestart=true
redirect_stderr=true

15
conf/systemd.service Normal file
View file

@ -0,0 +1,15 @@
[Unit]
Description=I hate money
Requires=network.target mysql.service
After=network.target mysql.service
[Service]
Type=simple
User=__APP__
Environment=IHATEMONEY_SETTINGS_FILE_PATH=__FINALPATH__/ihatemoney.cfg
ExecStart=__FINALPATH__/venv/bin/gunicorn -c __FINALPATH__/gunicorn.conf.py ihatemoney.wsgi:application
Restart=always
RestartSec=2
[Install]
WantedBy=multi-user.target

10
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,10 @@
* LDAP authentication and Single Sign-on is not supported. The login mechanism in IHateMoney is per-project (not per-user) and therefore can't be integrated in YunoHost.
- **non-public app**:
- yunohost login required
- per-project identifiers required
- any yunohost user with access to the app can create a new project.
- **public app** :
- no yunohost login required
- per-project identifiers required
- any visitor can create a new project.

10
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,10 @@
* L'authentification LDAP et login unifié (SSO) n'est pas supportée. Le mécanisme de connexion sur IHateMoney se fait par projet et ne peut donc pas être intégrée dans YunoHost
- **app non publique**:
- authentification Yunohost requise
- identifiants de projets requis
- Tout utilisateur Yunohost avec accès à l'app peut créer un nouveau projet.
- **app publique** :
- authentification Yunohost non requise
- identifiants de projets requis
- Tout visiteur peut créer un nouveau projet.

BIN
doc/screenshots/screenshot_1_global.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/screenshots/screenshot_2_new_operation.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 12 KiB

38
manifest.json
View file

@ -3,49 +3,47 @@
"id": "ihatemoney", "id": "ihatemoney",
"packaging_format": 1, "packaging_format": 1,
"description": { "description": {
"en": "A simple shared budget manager web application", "en": "Simple app to manage your collective expenses",
"fr": "Une application web de comptes partagés à plusieurs" "fr": "Gérez simplement vos dépenses collectives"
}, },
"url": "http://ihatemoney.org/", "url": "http://ihatemoney.org/",
"version": "4.1.5~ynh2", "version": "4.1.5~ynh3",
"license": "free", "license": "MIT",
"upstream": {
"license": "MIT",
"website": "https://github.com/spiral-project/ihatemoney",
"admindoc": "https://ihatemoney.readthedocs.org/",
"code": "https://github.com/spiral-project/ihatemoney",
"demo": "https://ihatemoney.org/demo/"
},
"maintainer": { "maintainer": {
"name": "Jocelyn Delalande", "name": "Jocelyn Delalande",
"email": "jocelyn@crapouillou.net", "email": "jocelyn@crapouillou.net",
"url": "https://jocelyn.delalande.fr" "url": "https://jocelyn.delalande.fr"
}, },
"requirements": { "requirements": {
"yunohost": ">= 3.8" "yunohost": ">= 4.1.0"
}, },
"multi_instance": false, "multi_instance": true,
"services": ["nginx", "mysql", "postfix"], "services": ["nginx", "mysql", "postfix"],
"arguments": { "arguments": {
"install" : [ "install" : [
{ {
"name": "domain", "name": "domain",
"type": "domain", "type": "domain"
"ask": {
"en": "Choose a domain for ihatemoney",
"fr": "Choisir un domaine pour ihatemoney"
},
"example": "example.com"
}, },
{ {
"name": "path", "name": "path",
"type": "path", "type": "path",
"ask": { "example": "/ihatemoney",
"en": "Choose a path for ihatemoney",
"fr": "Choisir un chemin pour ihatemoney"
},
"example": "/example",
"default": "/ihatemoney" "default": "/ihatemoney"
}, },
{ {
"name": "is_public", "name": "is_public",
"type": "boolean", "type": "boolean",
"ask": { "help": {
"en": "Is it a public website ? (even if service is public, each project is protected by a password)", "en": "Each ihatemoney project is protected by a password anyways",
"fr": "Le service est-il public ? (même dans ce cas, chaque projet est protégé par un mot de passe)" "fr": "Les projets ihatemoney sont protégés par un mot de passe dans tous les cas"
}, },
"default": true "default": true
} }

103
scripts/_common.sh
View file

@ -1,69 +1,56 @@
#!/bin/bash
#=================================================
# COMMON VARIABLES
#=================================================
# dependencies used by the app
pkg_dependencies=(
python3-dev
python3-venv
libffi-dev
libssl-dev
)
pip_dependencies=(
'setuptools>=18.5'
'gunicorn>=19.3.0'
'PyMySQL>=0.9,<0.10'
'SQLAlchemy<1.4'
'ihatemoney>=4,<5'
)
### Constants ### Constants
supervisor_conf_path="/etc/supervisor/conf.d/ihatemoney.conf" #=================================================
gunicorn_conf_path="/etc/ihatemoney/gunicorn.conf.py" # PERSONAL HELPERS
ihatemoney_conf_path="/etc/ihatemoney/ihatemoney.cfg" #=================================================
INSTALL_DIR="/opt/yunohost/ihatemoney"
__ynh_python_venv_setup() {
local -A args_array=( [d]=venv_dir= [p]=packages= )
local venv_dir
local packages
ynh_handle_getopts_args "$@"
### Functions python3 -m venv --system-site-packages "$venv_dir"
IFS=" " read -r -a pip_packages <<< "$packages"
install_apt_dependencies() { "$venv_dir/bin/python3" -m pip install --upgrade pip "${pip_packages[@]}"
ynh_install_app_dependencies \
python3-dev \
python3-virtualenv \
libffi-dev \
libssl-dev \
supervisor \
virtualenv
} }
create_unix_user() { __ynh_python_venv_get_site_packages_dir() {
mkdir -p /opt/yunohost local -A args_array=( [d]=venv_dir= )
useradd ihatemoney -d /opt/yunohost/ihatemoney/ --create-home || ynh_die "User creation failed" local venv_dir
ynh_handle_getopts_args "$@"
"$venv_dir/bin/python3" -c 'import sysconfig; print(sysconfig.get_paths()["purelib"])'
} }
create_system_dirs() {
install -o ihatemoney -g ihatemoney -m 755 -d \
/var/log/ihatemoney \
/etc/ihatemoney
mkdir -p /opt/yunohost
}
init_virtualenv () { #=================================================
virtualenv /opt/yunohost/ihatemoney/venv --python /usr/bin/python3 # EXPERIMENTAL HELPERS
#=================================================
# PyMySQL → cryptography → setuptools>=18.5 #=================================================
# Required on Jessie, Stretch has setuptools>=18.5 # FUTURE OFFICIAL HELPERS
/opt/yunohost/ihatemoney/venv/bin/pip install 'setuptools>=18.5' #=================================================
}
pip_install () {
# SQLAlchemy requirement is workaround https://github.com/pallets/flask-sqlalchemy/issues/910
# Might be removed later when IHM dependency set will no longer prevent working installation.
/opt/yunohost/ihatemoney/venv/bin/pip install --upgrade \
'gunicorn>=19.3.0' \
'PyMySQL>=0.9,<0.10' \
'ihatemoney>=4,<5' \
'SQLAlchemy<1.4' \
}
configure_nginx () {
local domain=$1
local path=$2
local python_version="$(readlink /usr/bin/python3|sed s/.*python//)"
ynh_replace_string "PATHTOCHANGE" "$path" ../conf/nginx.conf
ynh_replace_string "PYTHON_VERSION" "$python_version" ../conf/nginx.conf
# Fix double-slash for domain-root install
ynh_replace_string "location //" "location /" ../conf/nginx.conf
install -o root -g root -m644 \
../conf/nginx.conf /etc/nginx/conf.d/$domain.d/ihatemoney.conf
}
configure_supervisor () {
install -o root -g root -m 644 \
../conf/supervisord.conf /etc/supervisor/conf.d/ihatemoney.conf
}

88
scripts/backup Normal file → Executable file
View file

@ -1,34 +1,82 @@
#!/bin/bash #!/bin/bash
# Source YunoHost helpers #=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors ynh_abort_if_errors
# Get multi-instances specific variables #=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info --message="Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
# Set app specific variables final_path=$(ynh_app_setting_get --app=$app --key=final_path)
dbname=$app domain=$(ynh_app_setting_get --app=$app --key=domain)
dbuser=$app db_name=$(ynh_app_setting_get --app=$app --key=db_name)
INSTALL_DIR=/opt/yunohost/ihatemoney #=================================================
# DECLARE DATA AND CONF FILES TO BACKUP
#=================================================
ynh_print_info --message="Declaring files to be backed up..."
# Retrieve app settings ### N.B. : the following 'ynh_backup' calls are only a *declaration* of what needs
domain=$(ynh_app_setting_get "$app" domain) ### to be backuped and not an actual copy of any file. The actual backup that
path=$(ynh_app_setting_get "$app" path) ### creates and fill the archive with the files happens in the core after this
dbpass=$(ynh_app_setting_get "$app" mysqlpwd) ### script is called. Hence ynh_backups calls takes basically 0 seconds to run.
# Backup conf files #=================================================
mkdir ./conf # BACKUP THE APP MAIN DIR
ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" #=================================================
ynh_backup "$gunicorn_conf_path"
ynh_backup "$supervisor_conf_path"
ynh_backup "$ihatemoney_conf_path"
# Dump the database ynh_backup --src_path="$final_path"
mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./db.sql
# Backup code and venv #=================================================
ynh_backup "$INSTALL_DIR" "install_dir" # BACKUP THE NGINX CONFIGURATION
#=================================================
ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# BACKUP FAIL2BAN CONFIGURATION
#=================================================
# ynh_backup --src_path="/etc/fail2ban/jail.d/$app.conf"
# ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf"
#=================================================
# SPECIFIC BACKUP
#=================================================
# BACKUP SYSTEMD
#=================================================
ynh_backup --src_path="/etc/systemd/system/$app.service"
#=================================================
# BACKUP THE MYSQL DATABASE
#=================================================
ynh_print_info --message="Backing up the MySQL database..."
### (However, things like MySQL dumps *do* take some time to run, though the
### copy of the generated dump to the archive still happens later)
ynh_mysql_dump_db --database="$db_name" > db.sql
#=================================================
# END OF SCRIPT
#=================================================
ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

150
scripts/change_url Normal file
View file

@ -0,0 +1,150 @@
#!/bin/bash
#=================================================
# GENERIC STARTING
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
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
app=$YNH_APP_INSTANCE_NAME
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
# Needed for helper "ynh_add_nginx_config"
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
python_venv_site_packages=$(__ynh_python_venv_get_site_packages_dir -d "$final_path/venv")
#=================================================
# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=8
# 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
#=================================================
# STOP SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Stopping a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
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
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
#=================================================
# SPECIFIC MODIFICATIONS
#=================================================
# Setup ihatemoney.cfg
#=================================================
path_url="$new_path"
domain="$new_domain"
# Secret key for cookies encryption.
secret_key=$(ynh_string_random --length 32)
mails_sender="no-reply@$domain"
# Allows to comment some config lines if not using sub path
sub_path_only="$(if [[ "$path_url" == "/" ]]; then echo '# ' ; else echo ''; fi)"
ynh_backup_if_checksum_is_different --file="$final_path/ihatemoney.cfg"
ynh_add_config --template ../conf/ihatemoney.cfg --destination "$final_path/ihatemoney.cfg"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#=================================================
# GENERIC FINALISATION
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=5
ynh_systemd_action --service_name=$app --action="start" --log_path=systemd
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Change of URL completed for $app" --last

229
scripts/install
View file

@ -1,88 +1,191 @@
#!/bin/bash #!/bin/bash
# Source YunoHost helpers #=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
# Retrieve arguments #=================================================
domain=$YNH_APP_ARG_DOMAIN # MANAGE SCRIPT FAILURE
path=$YNH_APP_ARG_PATH #=================================================
is_public=$YNH_APP_ARG_IS_PUBLIC
app=ihatemoney
# Database settings
db_pwd=$(ynh_string_random)
db_name=$app
db_user=$app
# Constant arguments
secret_key=$(ynh_string_random --length 32)
mails_sender="no-reply@${domain}"
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors ynh_abort_if_errors
ynh_webpath_register $app $domain $path #=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
# Configure database domain=$YNH_APP_ARG_DOMAIN
ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd" path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC
app=$YNH_APP_INSTANCE_NAME
# Save app settings #=================================================
ynh_app_setting_set "$app" mysqlpwd "$db_pwd" # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
ynh_app_setting_set "$app" is_public "$is_public" #=================================================
ynh_script_progression --message="Validating installation parameters..." --weight=1
install_apt_dependencies final_path=/var/www/$app
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
create_unix_user # Register (book) web path
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
# Prepare venv #=================================================
init_virtualenv # STORE SETTINGS FROM MANIFEST
pip_install #=================================================
ynh_script_progression --message="Storing installation settings..." --weight=1
create_system_dirs ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url
# Configure gunicorn #=================================================
install -o ihatemoney -g ihatemoney -m 644 \ # STANDARD MODIFICATIONS
../conf/gunicorn.conf.py /etc/ihatemoney/gunicorn.conf.py #=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Installing dependencies..." --weight=3
# Configure supervisor ynh_install_app_dependencies "${pkg_dependencies[@]}"
configure_supervisor
# In case it was already installed before,
# so that it picks /etc/supervisor/conf.d/ihatemoney.conf:
supervisorctl update
yunohost service add supervisor
# Configure ihatemoney #=================================================
ynh_replace_string "MY_SECRET_KEY" "$secret_key" ../conf/ihatemoney.cfg # CREATE DEDICATED USER
ynh_replace_string "MY_EMAIL" "$mails_sender" ../conf/ihatemoney.cfg #=================================================
ynh_replace_string "MY_MYSQL_PW" "$db_pwd" ../conf/ihatemoney.cfg ynh_script_progression --message="Configuring system user..." --weight=1
ynh_replace_string "MY_PATH" "$path" ../conf/ihatemoney.cfg
# Remove the conf directive if served at root
sed -i "/APPLICATION_ROOT='\/'/d" ../conf/ihatemoney.cfg
install -o ihatemoney -g ihatemoney -m 640 \
../conf/ihatemoney.cfg /etc/ihatemoney/ihatemoney.cfg
# If app is public, add url to SSOWat conf as skipped_uris # Create a system user
if [[ "$is_public" -ne 0 ]]; ynh_system_user_create --username=$app --home_dir="$final_path"
then
ynh_app_setting_set $app unprotected_uris "/"
fi
# Configure Nginx #=================================================
configure_nginx "$domain" "$path" # CREATE A MYSQL DATABASE
#=================================================
ynh_script_progression --message="Creating a MySQL database..." --weight=1
# Start backend db_name=$(ynh_sanitize_dbid --db_name=$app)
systemctl start supervisor db_user=$db_name
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
# defines $db_pwd and setting mysqlpwd
# Wait that gunicorn is ready to consider the install finished, that is to #=================================================
# avoid HTTP 502 right after installation # SPECIFIC SETUP
for i in `seq 1 120` #=================================================
do # Init venv
test -S /tmp/budget.gunicorn.sock && break #=================================================
ynh_script_progression --message="Configuring the app's installation..." --weight=6
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
__ynh_python_venv_setup --venv_dir="$final_path/venv" --packages "${pip_dependencies[*]}"
python_venv_site_packages=$(__ynh_python_venv_get_site_packages_dir -d "$final_path/venv")
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
# Create a dedicated NGINX config
## Needs $python_venv_site_packages
ynh_add_nginx_config
#=================================================
# Setup gunicorn
#=================================================
ynh_add_config --template ../conf/gunicorn.conf.py --destination "$final_path/gunicorn.conf.py"
chmod 644 "$final_path/gunicorn.conf.py"
#=================================================
# Setup ihatemoney
#=================================================
# Secret key for cookies encryption.
secret_key=$(ynh_string_random --length 32)
mails_sender="no-reply@$domain"
# Allows to comment some config lines if not using sub path
sub_path_only="$(if [[ "$path_url" == "/" ]]; then echo '# ' ; else echo ''; fi)"
ynh_add_config --template ../conf/ihatemoney.cfg --destination "$final_path/ihatemoney.cfg"
chmod 640 "$final_path/ihatemoney.cfg"
# FIXME: this should be managed by the core in the future
# Here, as a packager, you may have to tweak the ownerhsip/permissions
# such that the appropriate users (e.g. maybe www-data) can access
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#=================================================
# SETUP SYSTEMD
#=================================================
ynh_script_progression --message="Configuring a systemd service..." --weight=1
# Create a dedicated systemd config
ynh_add_systemd_config
#=================================================
# GENERIC FINALIZATION
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
yunohost service add $app --description="$app daemon for IHateMoney" --log=systemd
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1
# Start a systemd service
ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Booting worker" --timeout 30
# line_match isn't enough because ihatemoney may stop if database upgrades
for _ in {1..20}; do
test -S /tmp/budget.gunicorn_$app.sock && break
sleep 1 sleep 1
done done
# If socket not ready after 2 minutes waiting, ihatemoney will not work. #=================================================
test -S /tmp/budget.gunicorn.sock || ynh_die # SETUP FAIL2BAN
#=================================================
# ynh_script_progression --message="Configuring Fail2Ban..." --weight=1
systemctl reload nginx # Create a dedicated Fail2Ban config
# ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1
# Make app public if necessary
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
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Installation of $app completed" --last

120
scripts/remove
View file

@ -1,37 +1,109 @@
#!/bin/bash #!/bin/bash
# Source YunoHost helpers #=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
# supervisord and other Debian dependencies remain installed #=================================================
# there is no way to know if they are used by other programs # LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
# Retrieve arguments app=$YNH_APP_INSTANCE_NAME
app=ihatemoney
domain=$(ynh_app_setting_get $app domain)
db_user=$app
db_name=$app
# Stop service domain=$(ynh_app_setting_get --app=$app --key=domain)
supervisorctl stop budget db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
# Drop database #=================================================
ynh_mysql_drop_db $db_name # STANDARD REMOVE
ynh_mysql_drop_user $db_user #=================================================
# REMOVE SERVICE INTEGRATION IN YUNOHOST
#=================================================
# Remove src and venv # Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
ynh_secure_remove /opt/yunohost/ihatemoney if ynh_exec_warn_less yunohost service status $app >/dev/null
then
ynh_script_progression --message="Removing $app service integration..." --weight=1
yunohost service remove $app
fi
# Remove settings #=================================================
ynh_secure_remove /etc/ihatemoney # STOP AND REMOVE SERVICE
ynh_secure_remove /etc/supervisor/conf.d/ihatemoney.conf #=================================================
ynh_remove_nginx_config ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
# Restart services # Remove the dedicated systemd config
systemctl force-reload supervisor ynh_remove_systemd_config
# Remove app dependencies #=================================================
# REMOVE THE MYSQL DATABASE
#=================================================
ynh_script_progression --message="Removing the MySQL database..." --weight=1
# Remove a database if it exists, along with the associated user
ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
#=================================================
# REMOVE DEPENDENCIES
#=================================================
ynh_script_progression --message="Removing dependencies..." --weight=2
# Remove metapackage and its dependencies
ynh_remove_app_dependencies ynh_remove_app_dependencies
# Delete user #=================================================
userdel ihatemoney # REMOVE APP MAIN DIR
#=================================================
ynh_script_progression --message="Removing app main directory..." --weight=1
# Remove the app directory securely
ynh_secure_remove --file="$final_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
# Remove the dedicated NGINX config
ynh_remove_nginx_config
#=================================================
# REMOVE FAIL2BAN CONFIGURATION
#=================================================
# ynh_script_progression --message="Removing Fail2ban configuration..." --weight=1
# # Remove the dedicated Fail2Ban config
# ynh_remove_fail2ban_config
#=================================================
# SPECIFIC REMOVE
#=================================================
# REMOVE VARIOUS FILES
#=================================================
ynh_script_progression --message="Removing configuration files..." --weight=1
# Remove the log files
ynh_secure_remove --file="/var/log/$app"
#=================================================
# GENERIC FINALIZATION
#=================================================
# REMOVE DEDICATED USER
#=================================================
ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user
ynh_system_user_delete --username=$app
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Removal of $app completed" --last

157
scripts/restore Normal file → Executable file
View file

@ -1,58 +1,145 @@
#!/bin/bash #!/bin/bash
# Source app helpers #=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors ynh_abort_if_errors
# Get multi-instances specific variables #=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
# Set app specific variables domain=$(ynh_app_setting_get --app=$app --key=domain)
dbname=$app path_url=$(ynh_app_setting_get --app=$app --key=path)
dbuser=$app final_path=$(ynh_app_setting_get --app=$app --key=final_path)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
# Retrieve old app settings #=================================================
domain=$(ynh_app_setting_get "$app" domain) # CHECK IF THE APP CAN BE RESTORED
path=$(ynh_app_setting_get "$app" path) #=================================================
dbpass=$(ynh_app_setting_get "$app" mysqlpwd) ynh_script_progression --message="Validating restoration parameters..." --weight=1
test ! -d $final_path \
|| ynh_die --message="There is already a directory: $final_path "
test -d $INSTALL_DIR && ynh_die \ #=================================================
"The destination directory '$INSTALL_DIR' already exists.\ # STANDARD RESTORATION STEPS
You should safely delete it before restoring this app." #=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1
test -f $supervisor_conf_path && ynh_die \ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
"The Supervisor configuration already exists at '${supervisor_conf_path}'.
You should safely delete it before restoring this app."
test -f $gunicorn_conf_path && ynh_die \ #=================================================
"The Gunicorn configuration already exists at '${gunicorn_conf_path}'. # RECREATE THE DEDICATED USER
You should safely delete it before restoring this app." #=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
install_apt_dependencies # Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
create_unix_user #=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=1
create_system_dirs ynh_restore_file --origin_path="$final_path"
# Restore all backed-up files # FIXME: this should be managed by the core in the future
ynh_restore # Here, as a packager, you may have to tweak the ownerhsip/permissions
# such that the appropriate users (e.g. maybe www-data) can access
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
# Create and restore the database #=================================================
ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" # RESTORE FAIL2BAN CONFIGURATION
ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./db.sql #=================================================
# ynh_script_progression --message="Restoring the Fail2Ban configuration..." --weight=1
# Reload # ynh_restore_file "/etc/fail2ban/jail.d/$app.conf"
systemctl reload nginx # ynh_restore_file "/etc/fail2ban/filter.d/$app.conf"
systemctl restart supervisor # ynh_systemd_action --action=restart --service_name=fail2ban
supervisorctl restart budget
# Wait that gunicorn is ready to consider the install finished, that is to #=================================================
# avoid HTTP 502 right after installation # SPECIFIC RESTORATION
for i in `seq 1 120` #=================================================
do # REINSTALL DEPENDENCIES
test -S /tmp/budget.gunicorn.sock && break #=================================================
ynh_script_progression --message="Reinstalling dependencies..." --weight=4
# Define and install dependencies
ynh_install_app_dependencies "${pkg_dependencies[@]}"
#=================================================
# RESTORE THE MYSQL DATABASE
#=================================================
ynh_script_progression --message="Restoring the MySQL database..." --weight=1
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
#=================================================
# RESTORE SYSTEMD
#=================================================
ynh_script_progression --message="Restoring the systemd configuration..." --weight=1
ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
systemctl enable $app.service --quiet
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
yunohost service add $app --description="$app daemon for IHateMoney" --log=systemd
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Booting worker" --timeout 30
# line_match isn't enough because ihatemoney may stop if database upgrades
for _ in {1..20}; do
test -S /tmp/budget.gunicorn_$app.sock && break
sleep 1 sleep 1
done done
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX AND PHP-FPM
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Restoration completed for $app" --last

296
scripts/upgrade Executable file → Normal file
View file

@ -1,141 +1,227 @@
#!/bin/bash #!/bin/bash
#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_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=mysqlpwd)
# Installation paths #=================================================
INSTALL_DIR=/opt/yunohost/ihatemoney # CHECK VERSION
#=================================================
# Source YunoHost helpers ### This helper will compare the version of the currently installed app and the version of the upstream package.
. /usr/share/yunohost/helpers ### $upgrade_type can have 2 different values
### - UPGRADE_APP if the upstream app version has changed
### - UPGRADE_PACKAGE if only the YunoHost package has changed
### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
upgrade_type=$(ynh_check_app_version_changed)
domain=$(ynh_app_setting_get $app domain) if ynh_compare_current_package_version --comparison le --version "4.1.5~ynh2"; then
path=$(ynh_app_setting_get $app path) upgrade_from_opt=true
is_public=$(ynh_app_setting_get "$app" is_public) else
upgrade_from_opt=false
VENV_PY_VERSION=$(echo ${INSTALL_DIR}/venv/bin/python*.*|sed 's/.*python//')
SYSTEM_PY_VERSION=$(readlink /usr/bin/python3|sed s/.*python//)
# Source local utils
source _common.sh
ynh_clean_setup () {
if [ -e /opt/yunohost/ihatemoney/venv-old ]
then
mv /opt/yunohost/ihatemoney/venv{-old,}
fi fi
}
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=3
# 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 ynh_abort_if_errors
#=================================================
# STANDARD UPGRADE STEPS
#=================================================
# STOP SYSTEMD SERVICE
#=================================================
#----------------------------PRE-UPGRADE MIGRATIONS----------------------- if [[ "$upgrade_from_opt" == "false" ]]; then
ynh_script_progression --message="Stopping a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd
# MIGRATION: upgrade arg to typed boolean form
if (($is_public != 0)) && (($is_public != 1))
then
if [ $is_public = "No" ];
then
is_public=0
else
is_public=1
fi
ynh_app_setting_set "$app" is_public "$is_public"
fi fi
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
# MIGRATION: Switch to a python3 venv ynh_app_setting_delete --app=$app --key=is_public
if [[ "$VENV_PY_VERSION" == 2.7 ]]
then
install_apt_dependencies
# Trash py2 venv
mv ${INSTALL_DIR}/venv ${INSTALL_DIR}/venv-old
init_virtualenv
# Clears all cookie-sessions, because py2 & py3 sessions are incompatible
# Relates https://github.com/lepture/flask-wtf/issues/279 (fix unreleased)
new_secret_key=$(ynh_string_random 32)
ynh_replace_string "SECRET_KEY = \".*\"" "SECRET_KEY = \"${new_secret_key}\"" /etc/ihatemoney/ihatemoney.cfg
fi fi
# MIGRATION: Remove old code (from pre-4.1.5 versions, not using venv)
if [[ "$upgrade_from_opt" == "true" ]]; then
# Remove legacy install dir
ynh_secure_remove /opt/yunohost/ihatemoney
# MIGRATION: minor Py version has changed ? rebuilt venv # Remove legacy Supervisor config
rm -f /etc/supervisor/conf.d/ihatemoney.conf
# Useful for Py 3.4 → 3.5, Jessie → Stretch, ynh 2.x → 3.x
if [[ "$VENV_PY_VERSION" != '2.7' ]] && [[ "$VENV_PY_VERSION" != "$SYSTEM_PY_VERSION" ]]
then
mv ${INSTALL_DIR}/venv ${INSTALL_DIR}/venv-old
init_virtualenv
# the static path changed
configure_nginx "$domain" "$path"
fi
#-------------------------------UPGRADE-------------------------
# Upgrade code and dependencies
pip_install
#-----------------------POST-UPGRADE MIGRATIONS-----------------
# Python-MySQL is no longer maintained and does not support Py3
ynh_replace_string "'mysql://" "'mysql+pymysql://" ${ihatemoney_conf_path}
# MIGRATION: Remove old code (from pre-2.x versions, not using pip)
ynh_secure_remove ${INSTALL_DIR}/src
# MIGRATION: change the static path (from pre-2.x versions, not using pip)
if grep -q /opt/yunohost/ihatemoney/src/ /etc/nginx/conf.d/${domain}.d/ihatemoney.conf
then
# the static path changed
configure_nginx "$domain" "$path"
# Supervisor no longer change its directory to src/ dir
configure_supervisor
supervisorctl update
fi
# MIGRATION: new-style settings
if [ -e /etc/ihatemoney/settings.py ]; then if [ -e /etc/ihatemoney/settings.py ]; then
# Strip out the no longer used part of the settings # Strip out the no longer used part of the settings
python3 -c "d = open('/etc/ihatemoney/settings.py').read().replace('try:\n from settings import *\nexcept ImportError:\n pass\n', ''); open('/etc/ihatemoney/settings.py', 'w').write(d)" python3 -c "d = open('/etc/ihatemoney/settings.py').read().replace('try:\n from settings import *\nexcept ImportError:\n pass\n', ''); open('/etc/ihatemoney/settings.py', 'w').write(d)"
# Rename # Rename
mv /etc/ihatemoney/settings.py ${ihatemoney_conf_path} mv /etc/ihatemoney/settings.py "/etc/ihatemoney/ihatemoney.cfg"
fi fi
for old_file in "/etc/ihatemoney/ihatemoney.cfg" "/etc/$app/gunicorn.conf.py"; do
ynh_backup_if_checksum_is_different --file="$old_file"
ynh_delete_file_checksum --file="$old_file"
done
final_path=/var/www/$app
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
db_name=ihatemoney
db_user=$db_name
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
fi
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=1
ynh_install_app_dependencies "${pkg_dependencies[@]}"
#=================================================
# SPECIFIC UPGRADE
#=================================================
# Init venv
#=================================================
ynh_script_progression --message="Configuring the app's installation..." --weight=6
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# MIGRATION: Upgrade venv
python3 -m venv --upgrade "$final_path/venv"
"$final_path/venv/bin/python3" -m pip install --upgrade pip "${pip_dependencies[@]}"
python_venv_site_packages=$(__ynh_python_venv_get_site_packages_dir -d "$final_path/venv")
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
# Create a dedicated NGINX config
## Needs $python_venv_site_packages
ynh_add_nginx_config "PYTHON_VERSION"
#=================================================
# Setup gunicorn
#=================================================
ynh_add_config --template ../conf/gunicorn.conf.py --destination "$final_path/gunicorn.conf.py"
chmod 600 "$final_path/gunicorn.conf.py"
#=================================================
# Setup ihatemoney
#=================================================
# Secret key for cookies encryption.
secret_key=$(ynh_string_random --length 32)
mails_sender="no-reply@$domain"
# Allows to comment some config lines if not using sub path
sub_path_only="$(if [[ "$path_url" == "/" ]]; then echo '# ' ; else echo ''; fi)"
ynh_add_config --template ../conf/ihatemoney.cfg --destination "$final_path/ihatemoney.cfg"
chmod 600 "$final_path/ihatemoney.cfg"
# MIGRATION: Remove no longer used symlink # FIXME: this should be managed by the core in the future
# Here, as a packager, you may have to tweak the ownerhsip/permissions
# such that the appropriate users (e.g. maybe www-data) can access
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
# (ihatemoney now read its conf by default from /etc/ihatemoney/ihatemoney.cfg) #=================================================
ynh_secure_remove ${INSTALL_DIR}/src/budget/settings.py # SETUP SYSTEMD
#=================================================
ynh_script_progression --message="Upgrading systemd configuration..." --weight=1
# Create a dedicated systemd config
ynh_add_systemd_config
#=================================================
# GENERIC FINALIZATION
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
#----------------------------FINALIZATION----------------------- yunohost service add $app --description="$app daemon for IHateMoney" --log=systemd
# Everything went ok ? Let's keep this new venv. #=================================================
ynh_secure_remove ${INSTALL_DIR}/venv-old # START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1
# Restart backend ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Booting worker" --timeout 30
supervisorctl restart budget
# Reload nginx conf # line_match isn't enough because ihatemoney may stop if database upgrades
systemctl reload nginx # FIXME: We need to wait for the db to upgrade and gunicorn to restart!
sleep 3
#=================================================
# UPGRADE FAIL2BAN
#=================================================
# ynh_script_progression --message="Reconfiguring Fail2Ban..." --weight=1
# # Create a dedicated Fail2Ban config
# ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Upgrade of $app completed" --last