install 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  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 arguments ..."
  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 "Starting example app installation ..."
  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. ### Use these lines if you have to open a port for the application
  65. ### `ynh_find_port` will find the first available port starting from the given port.
  66. ### If you're not using these lines:
  67. ### - Remove the section "CLOSE A PORT" in the remove script
  68. ynh_print_info "Configuring firewall ..."
  69. # Find a free port
  70. port=$(ynh_find_port 8095)
  71. # Open this port
  72. yunohost firewall allow --no-upnp TCP $port 2>&1
  73. ynh_app_setting_set $app port $port
  74. #=================================================
  75. # INSTALL DEPENDENCIES
  76. #=================================================
  77. ### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
  78. ### Those deb packages will be installed as dependencies of this package.
  79. ### If you're not using this helper:
  80. ### - Remove the section "REMOVE DEPENDENCIES" in the remove script
  81. ### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
  82. ### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
  83. ynh_print_info "Installing dependencies ..."
  84. ynh_install_app_dependencies deb1 deb2
  85. #=================================================
  86. # CREATE A MYSQL DATABASE
  87. #=================================================
  88. ### Use these lines if you need a database for the application.
  89. ### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
  90. ### The password will be stored as 'mysqlpwd' into the app settings,
  91. ### and will be available as $db_pwd
  92. ### If you're not using these lines:
  93. ### - Remove the section "BACKUP THE MYSQL DATABASE" in the backup script
  94. ### - Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
  95. ### - As well as the section "RESTORE THE MYSQL DATABASE" in the restore script
  96. ynh_print_info "Initializing database ..."
  97. db_name=$(ynh_sanitize_dbid $app)
  98. ynh_app_setting_set $app db_name $db_name
  99. ynh_mysql_setup_db $db_name $db_name
  100. #=================================================
  101. # DOWNLOAD, CHECK AND UNPACK SOURCE
  102. #=================================================
  103. ### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
  104. ### downloaded from an upstream source, like a git repository.
  105. ### `ynh_setup_source` use the file conf/app.src
  106. ynh_print_info "Setting up source files ..."
  107. ynh_app_setting_set $app final_path $final_path
  108. # Download, check integrity, uncompress and patch the source from app.src
  109. ynh_setup_source "$final_path"
  110. #=================================================
  111. # NGINX CONFIGURATION
  112. #=================================================
  113. ### `ynh_add_nginx_config` will use the file conf/nginx.conf
  114. ynh_print_info "Configuring nginx ..."
  115. # Create a dedicated nginx config
  116. ynh_add_nginx_config
  117. #=================================================
  118. # CREATE DEDICATED USER
  119. #=================================================
  120. # Create a system user
  121. ynh_print_info "Configuring system user ..."
  122. ynh_system_user_create $app
  123. #=================================================
  124. # PHP-FPM CONFIGURATION
  125. #=================================================
  126. ### `ynh_add_fpm_config` is used to set up a PHP config.
  127. ### You can remove it if your app doesn't use PHP.
  128. ### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini
  129. ### If you're not using these lines:
  130. ### - You can remove these files in conf/.
  131. ### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script
  132. ### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script
  133. ### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script
  134. ### With the reload at the end of the script.
  135. ### - And the section "PHP-FPM CONFIGURATION" in the upgrade script
  136. # Create a dedicated php-fpm config
  137. ynh_print_info "Configuring php-fpm ..."
  138. ynh_add_fpm_config
  139. #=================================================
  140. # SPECIFIC SETUP
  141. #=================================================
  142. # ...
  143. #=================================================
  144. #=================================================
  145. # SETUP SYSTEMD
  146. #=================================================
  147. ### `ynh_systemd_config` is used to configure a systemd script for an app.
  148. ### It can be used for apps that use sysvinit (with adaptation) or systemd.
  149. ### Have a look at the app to be sure this app needs a systemd script.
  150. ### `ynh_systemd_config` will use the file conf/systemd.service
  151. ### If you're not using these lines:
  152. ### - You can remove those files in conf/.
  153. ### - Remove the section "BACKUP SYSTEMD" in the backup script
  154. ### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script
  155. ### - As well as the section "RESTORE SYSTEMD" in the restore script
  156. ### - And the section "SETUP SYSTEMD" in the upgrade script
  157. # Create a dedicated systemd config
  158. ynh_print_info "Configuring systemd service ..."
  159. ynh_add_systemd_config
  160. #=================================================
  161. # SETUP APPLICATION WITH CURL
  162. #=================================================
  163. ### Use these lines only if the app installation needs to be finalized through
  164. ### web forms. We generally don't want to ask the final user,
  165. ### so we're going to use curl to automatically fill the fields and submit the
  166. ### forms.
  167. # Set right permissions for curl install
  168. chown -R $app: $final_path
  169. # Set the app as temporarily public for curl call
  170. ynh_print_info "Configuring ssowat ..."
  171. ynh_app_setting_set $app skipped_uris "/"
  172. # Reload SSOwat config
  173. yunohost app ssowatconf
  174. # Reload Nginx
  175. systemctl reload nginx
  176. # Installation with curl
  177. ynh_print_info "Finalizing install ..."
  178. ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
  179. # Remove the public access
  180. if [ $is_public -eq 0 ]
  181. then
  182. ynh_app_setting_delete $app skipped_uris
  183. fi
  184. #=================================================
  185. # MODIFY A CONFIG FILE
  186. #=================================================
  187. ### `ynh_replace_string` is used to replace a string in a file.
  188. ### (It's compatible with sed regular expressions syntax)
  189. ynh_replace_string "match_string" "replace_string" "$final_path/CONFIG_FILE"
  190. #=================================================
  191. # STORE THE CONFIG FILE CHECKSUM
  192. #=================================================
  193. ### `ynh_store_file_checksum` is used to store the checksum of a file.
  194. ### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`,
  195. ### you can make a backup of this file before modifying it again if the admin had modified it.
  196. # Calculate and store the config file checksum into the app settings
  197. ynh_store_file_checksum "$final_path/CONFIG_FILE"
  198. #=================================================
  199. # GENERIC FINALIZATION
  200. #=================================================
  201. # SECURE FILES AND DIRECTORIES
  202. #=================================================
  203. ### For security reason, any app should set the permissions to root: before anything else.
  204. ### Then, if write authorization is needed, any access should be given only to directories
  205. ### that really need such authorization.
  206. # Set permissions to app files
  207. chown -R root: $final_path
  208. #=================================================
  209. # SETUP LOGROTATE
  210. #=================================================
  211. ### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
  212. ### Use this helper only if there is effectively a log file for this app.
  213. ### If you're not using this helper:
  214. ### - Remove the section "BACKUP LOGROTATE" in the backup script
  215. ### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
  216. ### - As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script
  217. ### - And the section "SETUP LOGROTATE" in the upgrade script
  218. # Use logrotate to manage application logfile(s)
  219. ynh_print_info "Configuring log rotation ..."
  220. ynh_use_logrotate
  221. #=================================================
  222. # ADVERTISE SERVICE IN ADMIN PANEL
  223. #=================================================
  224. ### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
  225. ### You'll find the service in the 'services' section of YunoHost admin panel.
  226. ### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
  227. ### If you're not using these lines:
  228. ### - You can remove these files in conf/.
  229. ### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
  230. ### - As well as the section "ADVERTISE SERVICE IN ADMIN PANEL" in the restore script
  231. yunohost service add $app --log "/var/log/$app/$app.log"
  232. # if using yunohost version 3.2 or more in the 'manifest.json', a description can be added
  233. #yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$app/$app.log"
  234. #=================================================
  235. # SETUP SSOWAT
  236. #=================================================
  237. # Make app public if necessary
  238. if [ $is_public -eq 1 ]
  239. then
  240. # unprotected_uris allows SSO credentials to be passed anyway.
  241. ynh_app_setting_set $app unprotected_uris "/"
  242. fi
  243. #=================================================
  244. # RELOAD NGINX
  245. #=================================================
  246. ynh_print_info "Reloading nginx ..."
  247. systemctl reload nginx