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

cleaning

Browse source
This commit is contained in:
Éric Gaspar 2023-12-21 11:30:26 +01:00
parent 6e2d488d97
commit 996914dbf2
9 changed files with 26 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ADMIN.md
View file

@ -1,9 +1,9 @@
We have added the mandatory sandbox domain for you but you still need to configure your DNS and generate Let's Encrypt Certificates for it !! We have added the mandatory sandbox domain for you but you still need to configure your DNS and generate Let's Encrypt Certificates for it!
Once CryptPad is installed, create an account via the Register button on the home page. To make this account an instance administrator: Once CryptPad is installed, create an account via the Register button on the home page. To make this account an instance administrator:
1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key 1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key
2. Paste this key in `/var/www/cryptpad/config/config.js` in the following array (uncomment and replace the placeholder): 2. Paste this key in `__INSTALL_DIR__/config/config.js` in the following array (uncomment and replace the placeholder):
``` ```
adminKeys: [ adminKeys: [
"[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]",

2
doc/ADMIN_fr.md
View file

@ -5,7 +5,7 @@ Nous avons ajouté le domaine obligatoire sandbox pour vous mais vous devez enco
Une fois CryptPad installé, créez un compte via le bouton S'inscrire sur la page d'accueil. Pour faire de ce compte un administrateur d'instance : Une fois CryptPad installé, créez un compte via le bouton S'inscrire sur la page d'accueil. Pour faire de ce compte un administrateur d'instance :
1. Copiez la clé publique trouvée dans le menu utilisateur (avatar en haut à droite) > Paramètres > Compte > Clé de signature publique 1. Copiez la clé publique trouvée dans le menu utilisateur (avatar en haut à droite) > Paramètres > Compte > Clé de signature publique
2. Collez cette clé dans `/var/www/cryptpad/config/config.js` dans le tableau suivant (décommentez et remplacez l'espace réservé) : 2. Collez cette clé dans `__INSTALL_DIR__/config/config.js` dans le tableau suivant (décommentez et remplacez l'espace réservé) :
``` ```
adminKeys: [ adminKeys: [
"[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]",

2
doc/POST_INSTALL.md
View file

@ -7,7 +7,7 @@ Once CryptPad is installed, create an account via the Sign Up button on the home
To make this account an instance administrator: To make this account an instance administrator:
1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key 1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key
2. Paste this key in `/var/www/cryptpad/config/config.js` in the following array (uncomment and replace the placeholder): 2. Paste this key in `__INSTALL_DIR__/config/config.js` in the following array (uncomment and replace the placeholder):
``` ```
adminKeys: [ adminKeys: [

2
doc/POST_UPGRADE.md
View file

@ -3,7 +3,7 @@ If not already done, then you can please open CryptPad domain: https://__DOMAIN_
Create an account via the Register button on the home page. To make this account an instance administrator: Create an account via the Register button on the home page. To make this account an instance administrator:
1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key 1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key
2. Paste this key in /var/www/cryptpad/config/config.js in the following array (uncomment and replace the placeholder): 2. Paste this key in `__INSTALL_DIR__/config/config.js` in the following array (uncomment and replace the placeholder):
adminKeys: [ adminKeys: [
"[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]",
], ],

4
scripts/change_url
View file

@ -16,7 +16,7 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_script_progression --message="Stopping a systemd service..." --weight=1 ynh_script_progression --message="Stopping a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
#================================================= #=================================================
# MODIFY URL IN NGINX CONF # MODIFY URL IN NGINX CONF
@ -32,7 +32,7 @@ ynh_change_url_nginx_config
#================================================= #=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_script_progression --message="Starting a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="server available" ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="server available"
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

8
scripts/install
View file

@ -87,18 +87,12 @@ chown $app "$install_dir/config/config.js"
#================================================= #=================================================
# INSTALL CRYPTPAD # INSTALL CRYPTPAD
#================================================= #=================================================
ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=60 ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=30
pushd "$install_dir" pushd "$install_dir"
ynh_use_nodejs ynh_use_nodejs
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm ci ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm ci
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm run install:components ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm run install:components
#ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm install --allow-root
#ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm install -g bower
#ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH bower install --allow-root
#ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH bower update --allow-root
#ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm run build
popd popd
#================================================= #=================================================

8
scripts/remove
View file

@ -16,24 +16,16 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
if ynh_exec_warn_less yunohost service status $app >/dev/null if ynh_exec_warn_less yunohost service status $app >/dev/null
then then
ynh_script_progression --message="Removing $app service integration..." --weight=3 ynh_script_progression --message="Removing $app service integration..." --weight=3
yunohost service remove $app yunohost service remove $app
fi fi
# Remove the dedicated systemd config
ynh_remove_systemd_config ynh_remove_systemd_config
# Remove the dedicated NGINX config
ynh_remove_nginx_config ynh_remove_nginx_config
#=================================================
# REMOVE DEPENDENCIES
#=================================================
ynh_script_progression --message="Removing dependencies..." --weight=3
ynh_remove_nodejs ynh_remove_nodejs
#================================================= #=================================================

1
scripts/restore
View file

@ -6,7 +6,6 @@
# IMPORT GENERIC HELPERS # 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

41
scripts/upgrade
View file

@ -39,7 +39,6 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
then then
ynh_script_progression --message="Upgrading source files..." --weight=1 ynh_script_progression --message="Upgrading source files..." --weight=1
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$install_dir" #--keep="config/config.js" ynh_setup_source --dest_dir="$install_dir" #--keep="config/config.js"
chmod -R o-rwx "$install_dir" chmod -R o-rwx "$install_dir"
@ -69,7 +68,7 @@ if [[ $domain == *".local" ]]; then
sandboxdomain=sandbox-$domain sandboxdomain=sandbox-$domain
fi fi
ynh_script_progression --message="Setting up sandobx domain: $sandboxdomain" --weight=1 ynh_script_progression --message="Setting up sandbox domain: $sandboxdomain" --weight=1
# We don't test that in CI # We don't test that in CI
if ! [ ${PACKAGE_CHECK_EXEC:-0} -eq 1 ]; then if ! [ ${PACKAGE_CHECK_EXEC:-0} -eq 1 ]; then
@ -89,6 +88,10 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
ynh_add_nginx_config ynh_add_nginx_config
env_path="$PATH" env_path="$PATH"
ynh_add_systemd_config
yunohost service add $app --description="Zero Knowledge realtime collaborative editor" --log="/var/log/$app/$app.log"
#================================================= #=================================================
# UPGRADE DEPENDENCIES # UPGRADE DEPENDENCIES
#================================================= #=================================================
@ -96,37 +99,27 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=6
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
#=================================================
# INSTALL CRYPTPAD
#=================================================
ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=60
pushd "$install_dir"
ynh_exec_warn_less npm install --allow-root
ynh_exec_warn_less npm install -g bower
ynh_exec_warn_less bower update --allow-root
ynh_exec_warn_less npm i
ynh_exec_warn_less npm run build
popd
#=================================================
# CREATE SYSTEMD SERVICE
#=================================================
# Create a dedicated systemd config
ynh_add_systemd_config
yunohost service add $app --description="Zero Knowledge realtime collaborative editor" --log="/var/log/$app/$app.log"
#================================================= #=================================================
# ADD UPGRADED CONFIG WITH SANDBOX # ADD UPGRADED CONFIG WITH SANDBOX
#================================================= #=================================================
ynh_script_progression --message="Updating a configuration file..." --weight=1 ynh_script_progression --message="Updating a configuration file..." --weight=1
ynh_add_config --template="../conf/config.js" --destination="$install_dir/config/config.js" ynh_add_config --template="config.js" --destination="$install_dir/config/config.js"
chmod 600 "$install_dir/config/config.js" chmod 600 "$install_dir/config/config.js"
chown $app "$install_dir/config/config.js" chown $app "$install_dir/config/config.js"
#=================================================
# INSTALL CRYPTPAD
#=================================================
ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=30
pushd "$install_dir"
ynh_use_nodejs
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm ci
ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH $ynh_npm run install:components
popd
#================================================= #=================================================
# START SYSTEMD SERVICE # START SYSTEMD SERVICE
#================================================= #=================================================