163 lines
6.5 KiB
Text
163 lines
6.5 KiB
Text
|
#!/bin/bash
|
||
|
|
### App file generated with YoloGen, the Yunohost app generator, version .
|
||
|
|
|
||
|
|
# This is the tutorial version of the app.
|
||
|
|
# It contains extra commands to explain what should be done in case you want to adjust some part of the script.
|
||
|
|
# Once you are done, you may remove them.
|
||
|
|
|
||
|
|
source _common.sh
|
||
|
|
source /usr/share/yunohost/helpers
|
||
|
|
|
||
|
|
### Install parameters are automatically saved as settings
|
||
|
|
###
|
||
|
|
### Settings are automatically loaded as bash variables
|
||
|
|
### in every app script context, therefore typically these will exist:
|
||
|
|
### - $domain
|
||
|
|
### - $path
|
||
|
|
### - $language
|
||
|
|
### ... etc
|
||
|
|
###
|
||
|
|
### Resources defined in the manifest are provisioned prior to this script
|
||
|
|
### and corresponding settings are also available, such as:
|
||
|
|
### - $install_dir
|
||
|
|
### - $port
|
||
|
|
### - $db_name
|
||
|
|
### ...
|
||
|
|
###
|
||
|
|
### $app is the app id (i.e. 'example' for first install,
|
||
|
|
### or 'example__2', '__3'... for multi-instance installs)
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# INSTALL DEPENDENCIES
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||
|
|
#=================================================
|
||
|
|
ynh_script_progression "Setting up source files..."
|
||
|
|
|
||
|
|
### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
|
||
|
|
### downloaded from an upstream source, as defined in the manifest.toml
|
||
|
|
|
||
|
|
ynh_setup_source --dest_dir="$install_dir"
|
||
|
|
|
||
|
|
# $install_dir will automatically be initialized with some decent
|
||
|
|
# permission by default ... however, you may need to recursively reapply
|
||
|
|
# ownership to all files such as after the ynh_setup_source step
|
||
|
|
|
||
|
|
chown -R $app:www-data "$install_dir"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# ADD A CONFIGURATION
|
||
|
|
#=================================================
|
||
|
|
ynh_script_progression "Adding app's configuration file..."
|
||
|
|
|
||
|
|
### You can add specific configuration files.
|
||
|
|
###
|
||
|
|
### Typically, put your template conf file in ../conf/your_config_file
|
||
|
|
### The template may contain strings such as __FOO__ or __FOO_BAR__,
|
||
|
|
### which will automatically be replaced by the values of $foo and $foo_bar
|
||
|
|
###
|
||
|
|
### ynh_config_add will also keep track of the config file's checksum,
|
||
|
|
### which later during upgrade may allow to automatically backup the config file
|
||
|
|
### if it's found that the file was manually modified
|
||
|
|
###
|
||
|
|
### Check the documentation of `ynh_config_add` for more info.
|
||
|
|
|
||
|
|
ynh_config_add --template="" --destination="$install_dir/"
|
||
|
|
|
||
|
|
# FIXME: this should be handled by the core in the future
|
||
|
|
### You may need to use chmod 600 instead of 400,
|
||
|
|
### for example if the app is expected to be able to modify its own config
|
||
|
|
|
||
|
|
chmod 400 "$install_dir/"
|
||
|
|
chown "$app:$app" "$install_dir/"
|
||
|
|
|
||
|
|
### For more complex cases where you want to replace stuff using regexes,
|
||
|
|
### you shoud rely on ynh_replace_string (which is basically a wrapper for sed)
|
||
|
|
### When doing so, you also need to manually call ynh_store_file_checksum
|
||
|
|
###
|
||
|
|
### ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$install_dir/"
|
||
|
|
### ynh_store_file_checksum --file="$install_dir/"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# SYSTEM CONFIGURATION
|
||
|
|
#=================================================
|
||
|
|
ynh_script_progression "Adding system configurations related to $app..."
|
||
|
|
|
||
|
|
# Create a dedicated NGINX config using the conf/nginx.conf template
|
||
|
|
|
||
|
|
ynh_config_add_nginx
|
||
|
|
|
||
|
|
### `ynh_config_add_systemd` is used to configure a systemd script for an app.
|
||
|
|
### It can be used for apps that use sysvinit (with adaptation) or systemd.
|
||
|
|
### Have a look at the app to be sure this app needs a systemd script.
|
||
|
|
### `ynh_config_add_systemd` will use the file conf/systemd.service
|
||
|
|
|
||
|
|
ynh_config_add_systemd
|
||
|
|
|
||
|
|
### `yunohost service add` integrates a service in YunoHost. It then gets
|
||
|
|
### displayed in the admin interface and through the others `yunohost service` commands.
|
||
|
|
### (N.B.: this line only makes sense if the app adds a service to the system!)
|
||
|
|
|
||
|
|
### Additional options starting with 3.8:
|
||
|
|
###
|
||
|
|
### --needs_exposed_ports "$port" a list of ports that needs to be publicly exposed
|
||
|
|
### which will then be checked by YunoHost's diagnosis system
|
||
|
|
### (N.B. DO NOT USE THIS if the port is only internal!!!)
|
||
|
|
###
|
||
|
|
### --test_status "some command" a custom command to check the status of the service
|
||
|
|
### (only relevant if 'systemctl status' doesn't do a good job)
|
||
|
|
###
|
||
|
|
### --test_conf "some command" some command similar to "nginx -t" that validates the conf of the service
|
||
|
|
###
|
||
|
|
### Re-calling 'yunohost service add' during the upgrade script is the right way
|
||
|
|
### to proceed if you later realize that you need to enable some flags that
|
||
|
|
### weren't enabled on old installs (be careful it'll override the existing
|
||
|
|
### service though so you should re-provide all relevant flags when doing so)
|
||
|
|
|
||
|
|
yunohost service add "$app" --description="A short description of the app" --log="/var/log/$app/$app.log"
|
||
|
|
|
||
|
|
ynh_config_add_logrotate
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# INSTALL APP
|
||
|
|
#=================================================
|
||
|
|
ynh_script_progression "Installing $app..."
|
||
|
|
|
||
|
|
pushd $install_dir
|
||
|
|
some_command --build
|
||
|
|
popd
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# FINALIZE APP INSTALL WITH CURL
|
||
|
|
#=================================================
|
||
|
|
ynh_script_progression "Finalizing installation..."
|
||
|
|
|
||
|
|
### Use these lines only if the app installation needs to be finalized through
|
||
|
|
### web forms. We generally don't want to ask the final user,
|
||
|
|
### so we're going to use curl to automatically fill the fields and submit the
|
||
|
|
### forms.
|
||
|
|
|
||
|
|
ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# START SYSTEMD SERVICE
|
||
|
|
#=================================================
|
||
|
|
ynh_script_progression "Starting app's systemd service..."
|
||
|
|
|
||
|
|
### `ynh_systemctl` is used to start a systemd service for an app.
|
||
|
|
### Only needed if you have configure a systemd service
|
||
|
|
### If you're not using these lines:
|
||
|
|
### - Remove the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the backup script
|
||
|
|
### - As well as the section "START SYSTEMD SERVICE" in the restore script
|
||
|
|
### - As well as the section"STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the upgrade script
|
||
|
|
### - And the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the change_url script
|
||
|
|
|
||
|
|
ynh_systemd_action --service="$app" --action="start"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# END OF SCRIPT
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
ynh_script_progression "Installation of $app completed"
|