Une tentative de paquetage d'Invidious pour YunoHost
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

319 lines
12KB

  1. #!/bin/bash
  2. #=================================================
  3. # GENERIC START
  4. #=================================================
  5. # IMPORT GENERIC HELPERS
  6. #=================================================
  7. source _common.sh
  8. source /usr/share/yunohost/helpers
  9. #=================================================
  10. # MANAGE SCRIPT FAILURE
  11. #=================================================
  12. ynh_clean_setup () {
  13. ### Remove this function if there's nothing to clean before calling the remove script.
  14. true
  15. }
  16. # Exit if an error occurs during the execution of the script
  17. ynh_abort_if_errors
  18. #=================================================
  19. # RETRIEVE ARGUMENTS FROM THE MANIFEST
  20. #=================================================
  21. domain=$YNH_APP_ARG_DOMAIN
  22. path_url=$YNH_APP_ARG_PATH
  23. admin=$YNH_APP_ARG_ADMIN
  24. is_public=$YNH_APP_ARG_IS_PUBLIC
  25. language=$YNH_APP_ARG_LANGUAGE
  26. password=$YNH_APP_ARG_PASSWORD
  27. ### If it's a multi-instance app, meaning it can be installed several times independently
  28. ### The id of the app as stated in the manifest is available as $YNH_APP_ID
  29. ### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
  30. ### The app instance name is available as $YNH_APP_INSTANCE_NAME
  31. ### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
  32. ### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
  33. ### - ynhexample__{N} for the subsequent installations, with N=3,4, ...
  34. ### The app instance name is probably what interests you most, since this is
  35. ### guaranteed to be unique. This is a good unique identifier to define installation path,
  36. ### db names, ...
  37. app=$YNH_APP_INSTANCE_NAME
  38. #=================================================
  39. # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
  40. #=================================================
  41. ynh_print_info "Validating installation parameters..."
  42. ### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
  43. ### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
  44. final_path=/var/www/$app
  45. test ! -e "$final_path" || ynh_die "This path already contains a folder"
  46. # Normalize the url path syntax
  47. path_url=$(ynh_normalize_url_path $path_url)
  48. # Register (book) web path
  49. ynh_webpath_register $app $domain $path_url
  50. #=================================================
  51. # STORE SETTINGS FROM MANIFEST
  52. #=================================================
  53. ynh_print_info "Storing installation settings..."
  54. ynh_app_setting_set $app domain $domain
  55. ynh_app_setting_set $app path $path_url
  56. ynh_app_setting_set $app admin $admin
  57. ynh_app_setting_set $app is_public $is_public
  58. ynh_app_setting_set $app language $language
  59. #=================================================
  60. # STANDARD MODIFICATIONS
  61. #=================================================
  62. # FIND AND OPEN A PORT
  63. #=================================================
  64. ynh_print_info "Configuring firewall..."
  65. ### Use these lines if you have to open a port for the application
  66. ### `ynh_find_port` will find the first available port starting from the given port.
  67. ### If you're not using these lines:
  68. ### - Remove the section "CLOSE A PORT" in the remove script
  69. # Find a free port
  70. port=$(ynh_find_port 8095)
  71. # Open this port
  72. ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port
  73. ynh_app_setting_set $app port $port
  74. #=================================================
  75. # INSTALL DEPENDENCIES
  76. #=================================================
  77. ynh_print_info "Installing dependencies..."
  78. ### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
  79. ### Those deb packages will be installed as dependencies of this package.
  80. ### If you're not using this helper:
  81. ### - Remove the section "REMOVE DEPENDENCIES" in the remove script
  82. ### - Remove the variable "pkg_dependencies" in _common.sh
  83. ### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
  84. ### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
  85. ynh_install_app_dependencies $pkg_dependencies
  86. #=================================================
  87. # CREATE A MYSQL DATABASE
  88. #=================================================
  89. ynh_print_info "Creating a MySQL database..."
  90. ### Use these lines if you need a database for the application.
  91. ### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
  92. ### The password will be stored as 'mysqlpwd' into the app settings,
  93. ### and will be available as $db_pwd
  94. ### If you're not using these lines:
  95. ### - Remove the section "BACKUP THE MYSQL DATABASE" in the backup script
  96. ### - Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
  97. ### - As well as the section "RESTORE THE MYSQL DATABASE" in the restore script
  98. db_name=$(ynh_sanitize_dbid $app)
  99. ynh_app_setting_set $app db_name $db_name
  100. ynh_mysql_setup_db $db_name $db_name
  101. #=================================================
  102. # DOWNLOAD, CHECK AND UNPACK SOURCE
  103. #=================================================
  104. ynh_print_info "Setting up source files..."
  105. ### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
  106. ### downloaded from an upstream source, like a git repository.
  107. ### `ynh_setup_source` use the file conf/app.src
  108. ynh_app_setting_set $app final_path $final_path
  109. # Download, check integrity, uncompress and patch the source from app.src
  110. ynh_setup_source "$final_path"
  111. #=================================================
  112. # NGINX CONFIGURATION
  113. #=================================================
  114. ynh_print_info "Configuring nginx web server..."
  115. ### `ynh_add_nginx_config` will use the file conf/nginx.conf
  116. # Create a dedicated nginx config
  117. ynh_add_nginx_config
  118. #=================================================
  119. # CREATE DEDICATED USER
  120. #=================================================
  121. ynh_print_info "Configuring system user..."
  122. # Create a system user
  123. ynh_system_user_create $app
  124. #=================================================
  125. # PHP-FPM CONFIGURATION
  126. #=================================================
  127. ynh_print_info "Configuring php-fpm..."
  128. ### `ynh_add_fpm_config` is used to set up a PHP config.
  129. ### You can remove it if your app doesn't use PHP.
  130. ### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini
  131. ### If you're not using these lines:
  132. ### - You can remove these files in conf/.
  133. ### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script
  134. ### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script
  135. ### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script
  136. ### With the reload at the end of the script.
  137. ### - And the section "PHP-FPM CONFIGURATION" in the upgrade script
  138. # Create a dedicated php-fpm config
  139. ynh_add_fpm_config
  140. #=================================================
  141. # SPECIFIC SETUP
  142. #=================================================
  143. # ...
  144. #=================================================
  145. #=================================================
  146. # SETUP SYSTEMD
  147. #=================================================
  148. ynh_print_info "Configuring a systemd service..."
  149. ### `ynh_systemd_config` is used to configure a systemd script for an app.
  150. ### It can be used for apps that use sysvinit (with adaptation) or systemd.
  151. ### Have a look at the app to be sure this app needs a systemd script.
  152. ### `ynh_systemd_config` will use the file conf/systemd.service
  153. ### If you're not using these lines:
  154. ### - You can remove those files in conf/.
  155. ### - Remove the section "BACKUP SYSTEMD" in the backup script
  156. ### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script
  157. ### - As well as the section "RESTORE SYSTEMD" in the restore script
  158. ### - And the section "SETUP SYSTEMD" in the upgrade script
  159. # Create a dedicated systemd config
  160. ynh_add_systemd_config
  161. #=================================================
  162. # SETUP APPLICATION WITH CURL
  163. #=================================================
  164. ### Use these lines only if the app installation needs to be finalized through
  165. ### web forms. We generally don't want to ask the final user,
  166. ### so we're going to use curl to automatically fill the fields and submit the
  167. ### forms.
  168. # Set right permissions for curl install
  169. chown -R $app: $final_path
  170. # Set the app as temporarily public for curl call
  171. ynh_print_info "Configuring SSOwat..."
  172. ynh_app_setting_set $app skipped_uris "/"
  173. # Reload SSOwat config
  174. yunohost app ssowatconf
  175. # Reload Nginx
  176. systemctl reload nginx
  177. # Installation with curl
  178. ynh_print_info "Finalizing installation..."
  179. ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
  180. # Remove the public access
  181. if [ $is_public -eq 0 ]
  182. then
  183. ynh_app_setting_delete $app skipped_uris
  184. fi
  185. #=================================================
  186. # MODIFY A CONFIG FILE
  187. #=================================================
  188. ### `ynh_replace_string` is used to replace a string in a file.
  189. ### (It's compatible with sed regular expressions syntax)
  190. ynh_replace_string "match_string" "replace_string" "$final_path/CONFIG_FILE"
  191. #=================================================
  192. # STORE THE CONFIG FILE CHECKSUM
  193. #=================================================
  194. ### `ynh_store_file_checksum` is used to store the checksum of a file.
  195. ### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`,
  196. ### you can make a backup of this file before modifying it again if the admin had modified it.
  197. # Calculate and store the config file checksum into the app settings
  198. ynh_store_file_checksum "$final_path/CONFIG_FILE"
  199. #=================================================
  200. # GENERIC FINALIZATION
  201. #=================================================
  202. # SECURE FILES AND DIRECTORIES
  203. #=================================================
  204. ### For security reason, any app should set the permissions to root: before anything else.
  205. ### Then, if write authorization is needed, any access should be given only to directories
  206. ### that really need such authorization.
  207. # Set permissions to app files
  208. chown -R root: $final_path
  209. #=================================================
  210. # SETUP LOGROTATE
  211. #=================================================
  212. ynh_print_info "Configuring log rotation..."
  213. ### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
  214. ### Use this helper only if there is effectively a log file for this app.
  215. ### If you're not using this helper:
  216. ### - Remove the section "BACKUP LOGROTATE" in the backup script
  217. ### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
  218. ### - As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script
  219. ### - And the section "SETUP LOGROTATE" in the upgrade script
  220. # Use logrotate to manage application logfile(s)
  221. ynh_use_logrotate
  222. #=================================================
  223. # ADVERTISE SERVICE IN ADMIN PANEL
  224. #=================================================
  225. ### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
  226. ### You'll find the service in the 'services' section of YunoHost admin panel.
  227. ### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
  228. ### If you're not using these lines:
  229. ### - You can remove these files in conf/.
  230. ### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
  231. ### - As well as the section "ADVERTISE SERVICE IN ADMIN PANEL" in the restore script
  232. yunohost service add $app --log "/var/log/$app/$app.log"
  233. # if using yunohost version 3.2 or more in the 'manifest.json', a description can be added
  234. #yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$app/$app.log"
  235. #=================================================
  236. # SETUP SSOWAT
  237. #=================================================
  238. ynh_print_info "Configuring SSOwat..."
  239. # Make app public if necessary
  240. if [ $is_public -eq 1 ]
  241. then
  242. # unprotected_uris allows SSO credentials to be passed anyway.
  243. ynh_app_setting_set $app unprotected_uris "/"
  244. fi
  245. #=================================================
  246. # RELOAD NGINX
  247. #=================================================
  248. ynh_print_info "Reloading nginx web server..."
  249. systemctl reload nginx
  250. #=================================================
  251. # END OF SCRIPT
  252. #=================================================
  253. ynh_print_info "Installation of $app completed"