denis/chibisafe_ynh
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Various typo fixes

Browse source
This commit is contained in:
Jimmy Monin 2018-07-01 09:57:16 +02:00
parent 846e701632
commit 1c9c94ef65
4 changed files with 41 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,3 +1,11 @@
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
- Copy this app before working on it.
- Edit `conf/nginx.conf` file to match application prerequisites.
- Edit `manifest.json` with application specific information.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Add a `LICENSE` file for the package.
- Edit `README.md`.
# Example app for YunoHost # Example app for YunoHost
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20%28Community%29/lastBuild/consoleFull) [![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20%28Community%29/lastBuild/consoleFull)
@ -21,7 +29,7 @@ Quick description of this app.
## Configuration ## Configuration
How to configure this app ? By an admin panel, an plain file with ssh, or any other way. How to configure this app: by an admin panel, a plain file with ssh, or any other way.
## Documentation ## Documentation
@ -32,7 +40,7 @@ How to configure this app ? By an admin panel, an plain file with ssh, or any ot
#### Multi-users support #### Multi-users support
Is LDAP and HTTP auth supported ? Are LDAP and HTTP auth supported?
Can the app be used by multiple users? Can the app be used by multiple users?
#### Supported architectures #### Supported architectures
@ -45,25 +53,17 @@ Can the app be used by multiple users ?
* Any known limitations. * Any known limitations.
## Additionnal informations ## Additional informations
* Other informations you would add about this application * Other informations you would add about this application
### Usage of this package
- Copy this app before working on it.
- Edit `conf/nginx.conf` file to match application prerequisites.
- Edit `manifest.json` with application specific information.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Add a `LICENSE` file for the package.
- Edit `README.md`.
**More information on the documentation page:** **More information on the documentation page:**
https://yunohost.org/packaging_apps https://yunohost.org/packaging_apps
## Links ## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
* APP website: Link to the official website of this app * App website: Link to the official website of this app
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
--- ---
@ -76,7 +76,7 @@ Please do your pull request to the [testing branch](https://github.com/YunoHost-
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --verbose sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing
or or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --verbose sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing
``` ```

44
scripts/install
View file

@ -38,7 +38,7 @@ password=$YNH_APP_ARG_PASSWORD
### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample ### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2 ### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
### - ynhexample__{N} for the subsequent installations, with N=3,4, ... ### - ynhexample__{N} for the subsequent installations, with N=3,4, ...
### The app instance name is probably what you are interested the most, since this is ### The app instance name is probably what interests you most, since this is
### guaranteed to be unique. This is a good unique identifier to define installation path, ### guaranteed to be unique. This is a good unique identifier to define installation path,
### db names, ... ### db names, ...
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
@ -75,7 +75,7 @@ ynh_app_setting_set $app language $language
#================================================= #=================================================
### Use these lines if you have to open a port for the application ### Use these lines if you have to open a port for the application
### `ynh_find_port` will find the first available port starting to the given port. ### `ynh_find_port` will find the first available port starting from the given port.
### If you're not using these lines: ### If you're not using these lines:
### - Remove the section "CLOSE A PORT" in the remove script ### - Remove the section "CLOSE A PORT" in the remove script
@ -89,7 +89,7 @@ ynh_app_setting_set $app port $port
# INSTALL DEPENDENCIES # INSTALL DEPENDENCIES
#================================================= #=================================================
### `ynh_install_app_dependencies` allow you to add any "apt" dependencies to the package. ### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
### Those deb packages will be installed as dependencies of this package. ### Those deb packages will be installed as dependencies of this package.
### If you're not using this helper: ### If you're not using this helper:
### - Remove the section "REMOVE DEPENDENCIES" in the remove script ### - Remove the section "REMOVE DEPENDENCIES" in the remove script
@ -120,7 +120,7 @@ ynh_mysql_setup_db $db_name $db_name
#================================================= #=================================================
### `ynh_setup_source` is used to install an app from a zip or tar.gz file, ### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
### from an upstream source, like a git repository. ### downloaded from an upstream source, like a git repository.
### `ynh_setup_source` use the file conf/app.src ### `ynh_setup_source` use the file conf/app.src
ynh_app_setting_set $app final_path $final_path ynh_app_setting_set $app final_path $final_path
@ -152,11 +152,11 @@ ynh_system_user_create $app
# PHP-FPM CONFIGURATION # PHP-FPM CONFIGURATION
#================================================= #=================================================
### `ynh_add_fpm_config` is used to set up an php config. ### `ynh_add_fpm_config` is used to set up a PHP config.
### You can remove it if your app doesn't use php. ### You can remove it if your app doesn't use PHP.
### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini ### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini
### If you're not using these lines: ### If you're not using these lines:
### - You can remove those files in conf/. ### - You can remove these files in conf/.
### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script ### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script
### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script ### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script
### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script ### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script
@ -177,8 +177,8 @@ ynh_add_fpm_config
#================================================= #=================================================
### `ynh_systemd_config` is used to configure a systemd script for an app. ### `ynh_systemd_config` is used to configure a systemd script for an app.
### It can be used for app would use sysvinit (with adaptation) or systemd. ### It can be used for apps that use sysvinit (with adaptation) or systemd.
### Have a look to the app to be sure this app need a systemd script. ### Have a look at the app to be sure this app needs a systemd script.
### `ynh_systemd_config` will use the file conf/systemd.service ### `ynh_systemd_config` will use the file conf/systemd.service
### If you're not using these lines: ### If you're not using these lines:
### - You can remove those files in conf/. ### - You can remove those files in conf/.
@ -194,9 +194,10 @@ ynh_add_systemd_config
# SETUP APPLICATION WITH CURL # SETUP APPLICATION WITH CURL
#================================================= #=================================================
### Use those lines only if the app need to be installed by a web application ### Use these lines only if the app installation needs to be finalized through
### Because, we don't want to ask the final user to it himself, ### web forms. We generally don't want to ask the final user,
### we're going to use curl to fill the field of the application. ### so we're going to use curl to automatically fill the fields and submit the
### forms.
# Set right permissions for curl install # Set right permissions for curl install
chown -R $app: $final_path chown -R $app: $final_path
@ -222,12 +223,13 @@ fi
# MODIFY A CONFIG FILE # MODIFY A CONFIG FILE
#================================================= #=================================================
### `ynh_replace_string` is used to replace string in a file. ### `ynh_replace_string` is used to replace a string in a file.
### (It's compatible with sed regular expressions syntax)
ynh_replace_string "match_string" "replace_string" "$final_path/CONFIG_FILE" ynh_replace_string "match_string" "replace_string" "$final_path/CONFIG_FILE"
#================================================= #=================================================
# STORE THE CHECKSUM OF THE CONFIG FILE # STORE THE CONFIG FILE CHECKSUM
#================================================= #=================================================
### `ynh_store_file_checksum` is used to store the checksum of a file. ### `ynh_store_file_checksum` is used to store the checksum of a file.
@ -243,9 +245,9 @@ ynh_store_file_checksum "$final_path/CONFIG_FILE"
# SECURE FILES AND DIRECTORIES # SECURE FILES AND DIRECTORIES
#================================================= #=================================================
### For security reason, any app should set the permission to root: before anything else. ### For security reason, any app should set the permissions to root: before anything else.
### Then, if write authorisation is needed, any access should be given only to directories ### Then, if write authorization is needed, any access should be given only to directories
### that really need such authorisations. ### that really need such authorization.
# Set permissions to app files # Set permissions to app files
chown -R root: $final_path chown -R root: $final_path
@ -255,7 +257,7 @@ chown -R root: $final_path
#================================================= #=================================================
### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app. ### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
### Use this helper only if there effectively a log for this app. ### Use this helper only if there is effectively a log file for this app.
### If you're not using this helper: ### If you're not using this helper:
### - Remove the section "BACKUP LOGROTATE" in the backup script ### - Remove the section "BACKUP LOGROTATE" in the backup script
### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script ### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
@ -269,11 +271,11 @@ ynh_use_logrotate
# ADVERTISE SERVICE IN ADMIN PANEL # ADVERTISE SERVICE IN ADMIN PANEL
#================================================= #=================================================
### `yunohost service add` is a cli yunohost command to add a service in the admin panel. ### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
### You'll find the service in the 'services' section of YunoHost admin panel. ### You'll find the service in the 'services' section of YunoHost admin panel.
### This cli command would be useless if the app does not have any services (systemd or sysvinit) ### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
### If you're not using these lines: ### If you're not using these lines:
### - You can remove those files in conf/. ### - You can remove these files in conf/.
### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script ### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
### - As well as the section ADVERTISE SERVICE IN ADMIN PANEL" in the restore script ### - As well as the section ADVERTISE SERVICE IN ADMIN PANEL" in the restore script

1
scripts/remove
View file

@ -16,6 +16,7 @@ source /usr/share/yunohost/helpers
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get $app domain) domain=$(ynh_app_setting_get $app domain)
port=$(ynh_app_setting_get $app port)
db_name=$(ynh_app_setting_get $app db_name) db_name=$(ynh_app_setting_get $app db_name)
db_user=$db_name db_user=$db_name
final_path=$(ynh_app_setting_get $app final_path) final_path=$(ynh_app_setting_get $app final_path)

4
scripts/upgrade
View file

@ -99,7 +99,7 @@ ynh_install_app_dependencies deb1 deb2
# CREATE DEDICATED USER # CREATE DEDICATED USER
#================================================= #=================================================
# Create the dedicated user (if not existing) # Create a dedicated user (if not existing)
ynh_system_user_create $app ynh_system_user_create $app
#================================================= #=================================================
@ -116,7 +116,7 @@ ynh_add_fpm_config
#================================================= #=================================================
### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. ### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
### And create a backup of this file if the checksum is different. So the file will be backup if the admin has modified it. ### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it.
ynh_backup_if_checksum_is_different "$final_path/CONFIG_FILE" ynh_backup_if_checksum_is_different "$final_path/CONFIG_FILE"
# Recalculate and store the checksum of the file for the next upgrade. # Recalculate and store the checksum of the file for the next upgrade.
ynh_store_file_checksum "$final_path/CONFIG_FILE" ynh_store_file_checksum "$final_path/CONFIG_FILE"