mirror of
https://github.com/YunoHost-Apps/koel_ynh.git
synced 2024-09-03 19:35:54 +02:00
tituspijean
GitHub
commit
91d9d8d2e1
30 changed files with 303 additions and 1014 deletions
23
LICENSE
23
LICENSE
|
|
@ -1,4 +1,21 @@
|
||||||
File containing the license of your package.
|
The MIT License (MIT)
|
||||||
|
|
||||||
More information here:
|
Copyright (c) 2023 YunoHost Contributors
|
||||||
https://choosealicense.com/
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
|
||||||
46
README.md
46
README.md
|
|
@ -1,62 +1,52 @@
|
||||||
# Packaging an app, starting from this example
|
|
||||||
|
|
||||||
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
|
||||||
* Edit the `manifest.json` with app specific info.
|
|
||||||
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
|
|
||||||
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
|
||||||
* Add a `LICENSE` file for the package.
|
|
||||||
* Edit `doc/DISCLAIMER*.md`
|
|
||||||
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
||||||
|
|
||||||
---
|
|
||||||
<!--
|
<!--
|
||||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||||
It shall NOT be edited by hand.
|
It shall NOT be edited by hand.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Example app for YunoHost
|
# Koel for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/example)  
|
[](https://dash.yunohost.org/appci/app/koel)  
|
||||||
|
|
||||||
[](https://install-app.yunohost.org/?app=example)
|
[](https://install-app.yunohost.org/?app=koel)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allows you to install Example app quickly and simply on a YunoHost server.
|
> *This package allows you to install Koel quickly and simply on a YunoHost server.
|
||||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This is a dummy description of this app features
|
Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side.
|
||||||
|
|
||||||
|
Targeting web developers, Koel embraces some of the more modern web technologies to do its job.
|
||||||
|
|
||||||
|
|
||||||
**Shipped version:** 1.0~ynh1
|
**Shipped version:** 6.11.2~ynh1
|
||||||
|
|
||||||
**Demo:** https://demo.example.com
|
**Demo:** https://demo.koel.dev
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: <https://example.com>
|
* Official app website: <https://koel.dev>
|
||||||
* Official user documentation: <https://yunohost.org/apps>
|
* Official admin documentation: <https://docs.koel.dev>
|
||||||
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
* Upstream app code repository: <https://github.com/koel/koel>
|
||||||
* Upstream app code repository: <https://some.forge.com/example/example>
|
* YunoHost documentation for this app: <https://yunohost.org/app_koel>
|
||||||
* YunoHost documentation for this app: <https://yunohost.org/app_example>
|
* Report a bug: <https://github.com/YunoHost-Apps/koel_ynh/issues>
|
||||||
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/koel_ynh/tree/testing).
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
sudo yunohost app upgrade koel -u https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
|
|
|
||||||
35
README_fr.md
35
README_fr.md
|
|
@ -3,49 +3,50 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
|
||||||
It shall NOT be edited by hand.
|
It shall NOT be edited by hand.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Example app pour YunoHost
|
# Koel pour YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/example)  
|
[](https://dash.yunohost.org/appci/app/koel)  
|
||||||
|
|
||||||
[](https://install-app.yunohost.org/?app=example)
|
[](https://install-app.yunohost.org/?app=koel)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d’installer Example app rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d’installer Koel rapidement et simplement sur un serveur YunoHost.
|
||||||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
||||||
|
|
||||||
## Vue d’ensemble
|
## Vue d’ensemble
|
||||||
|
|
||||||
Ceci est une fausse description des fonctionalités de l'app
|
Un simple service web de streaming audio personnel, écrit en Vue pour le client et en Laravel pour le serveur.
|
||||||
|
|
||||||
|
Destiné aux développeurs web, Koel utilise certaines des technologies web les plus modernes pour accomplir son travail.
|
||||||
|
|
||||||
|
|
||||||
**Version incluse :** 1.0~ynh1
|
**Version incluse :** 6.11.2~ynh1
|
||||||
|
|
||||||
**Démo :** https://demo.example.com
|
**Démo :** https://demo.koel.dev
|
||||||
|
|
||||||
## Captures d’écran
|
## Captures d’écran
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site officiel de l’app : <https://example.com>
|
* Site officiel de l’app : <https://koel.dev>
|
||||||
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
* Documentation officielle de l’admin : <https://docs.koel.dev>
|
||||||
* Documentation officielle de l’admin : <https://yunohost.org/packaging_apps>
|
* Dépôt de code officiel de l’app : <https://github.com/koel/koel>
|
||||||
* Dépôt de code officiel de l’app : <https://some.forge.com/example/example>
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_koel>
|
||||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
|
* Signaler un bug : <https://github.com/YunoHost-Apps/koel_ynh/issues>
|
||||||
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/koel_ynh/tree/testing).
|
||||||
|
|
||||||
Pour essayer la branche testing, procédez comme suit.
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
sudo yunohost app upgrade koel -u https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||||
158
conf/env
Normal file
158
conf/env
Normal file
|
|
@ -0,0 +1,158 @@
|
||||||
|
APP_NAME=Koel
|
||||||
|
APP_ENV=production
|
||||||
|
APP_DEBUG=true
|
||||||
|
APP_URL=https://__DOMAIN____PATH__
|
||||||
|
|
||||||
|
# A random 32-char string. You can leave this empty if use php artisan koel:init.
|
||||||
|
APP_KEY=__APP_KEY__
|
||||||
|
|
||||||
|
# Database connection name, which corresponds to the database driver.
|
||||||
|
# Possible values are:
|
||||||
|
# mysql (MySQL/MariaDB - default)
|
||||||
|
# pgsql (PostgreSQL)
|
||||||
|
# sqlsrv (Microsoft SQL Server)
|
||||||
|
# sqlite-persistent (Local sqlite file)
|
||||||
|
# IMPORTANT: This value must present for `artisan koel:init` command to work.
|
||||||
|
DB_CONNECTION=mysql
|
||||||
|
|
||||||
|
DB_HOST=127.0.0.1
|
||||||
|
DB_PORT=3306
|
||||||
|
DB_DATABASE=__DB_NAME__
|
||||||
|
DB_USERNAME=__DB_USER__
|
||||||
|
DB_PASSWORD=__DB_PWD__
|
||||||
|
|
||||||
|
|
||||||
|
# The ABSOLUTE path to your media. This value can always be changed later via the web interface.
|
||||||
|
MEDIA_PATH=__DATA_DIR__
|
||||||
|
|
||||||
|
|
||||||
|
# By default, Koel ignores dot files and folders. This greatly improves performance if your media
|
||||||
|
# root have folders like .git or .cache. If by any chance your media files are under a dot folder,
|
||||||
|
# set the following setting to false.
|
||||||
|
IGNORE_DOT_FILES=true
|
||||||
|
|
||||||
|
|
||||||
|
# The maximum scan time, in seconds. Increase this if you have a huge library.
|
||||||
|
# Note: This setting doesn't have effect when scanning via koel:sync.
|
||||||
|
APP_MAX_SCAN_TIME=600
|
||||||
|
|
||||||
|
|
||||||
|
# The memory limit, in MB, used by the scanning process.
|
||||||
|
# For example, if you want to set a memory limit of 2048MB, enter "2048" (without
|
||||||
|
# quotes) here.
|
||||||
|
MEMORY_LIMIT=
|
||||||
|
|
||||||
|
|
||||||
|
# The streaming method.
|
||||||
|
# Can be either 'php' (default), 'x-sendfile', or 'x-accel-redirect'
|
||||||
|
# See https://docs.koel.dev/#streaming-music for more information.
|
||||||
|
# Note: This setting doesn't have effect if the media needs transcoding (e.g. FLAC).
|
||||||
|
# ##################################################
|
||||||
|
# IMPORTANT: It's HIGHLY recommended to use 'x-sendfile' or 'x-accel-redirect' if
|
||||||
|
# you plan to use the Koel mobile apps.
|
||||||
|
# ##################################################
|
||||||
|
STREAMING_METHOD=x-accel-redirect
|
||||||
|
|
||||||
|
|
||||||
|
# Full text search driver.
|
||||||
|
# Koel supports all drivers supported by Laravel (see https://laravel.com/docs/9.x/scout).
|
||||||
|
# Available drivers: 'tntsearch' (default), 'database', 'algolia' or 'meilisearch'.
|
||||||
|
# For Algolia or MeiliSearch, you need to provide the corresponding credentials.
|
||||||
|
SCOUT_DRIVER=tntsearch
|
||||||
|
ALGOLIA_APP_ID=
|
||||||
|
ALGOLIA_SECRET=
|
||||||
|
MEILISEARCH_HOST=
|
||||||
|
MEILISEARCH_KEY=
|
||||||
|
|
||||||
|
|
||||||
|
# Last.fm API can be used to fetch artist and album information, as well as to
|
||||||
|
# allow users to connect to their Last.fm account and scrobble.
|
||||||
|
# To integrate Koel with Last.fm, create an API account at
|
||||||
|
# https://www.last.fm/api/account/create and set the credentials here.
|
||||||
|
# Consult Koel's doc for more information.
|
||||||
|
LASTFM_API_KEY=
|
||||||
|
LASTFM_API_SECRET=
|
||||||
|
|
||||||
|
|
||||||
|
# Spotify API can be used to fetch artist and album images.
|
||||||
|
# To integrate Koel with Spotify, create a Spotify application at
|
||||||
|
# https://developer.spotify.com/dashboard/applications and set the credentials here.
|
||||||
|
# Consult Koel's doc for more information.
|
||||||
|
SPOTIFY_CLIENT_ID=
|
||||||
|
SPOTIFY_CLIENT_SECRET=
|
||||||
|
|
||||||
|
|
||||||
|
# To use Amazon S3 with Koel, fill the info here and follow the
|
||||||
|
# installation guide at https://docs.koel.dev/aws-s3.html
|
||||||
|
AWS_ACCESS_KEY_ID=
|
||||||
|
AWS_SECRET_ACCESS_KEY=
|
||||||
|
AWS_REGION=
|
||||||
|
AWS_ENDPOINT=
|
||||||
|
|
||||||
|
|
||||||
|
# To integrate Koel with YouTube, set the API key here.
|
||||||
|
# See https://docs.koel.dev/3rd-party.html#youtube for more information.
|
||||||
|
YOUTUBE_API_KEY=
|
||||||
|
|
||||||
|
|
||||||
|
# You can also configure Koel to use a CDN to serve the media files.
|
||||||
|
# This url must be mapped to the home URL of your Koel's installation.
|
||||||
|
# No trailing slash.
|
||||||
|
CDN_URL=
|
||||||
|
|
||||||
|
|
||||||
|
# To transcode FLAC to MP3 and stream it on the fly, make sure the following settings are sane.
|
||||||
|
|
||||||
|
# The full path of ffmpeg binary.
|
||||||
|
FFMPEG_PATH=/usr/bin/ffmpeg
|
||||||
|
|
||||||
|
# The bit rate of the output mp3 stream. Higher value results in better quality,
|
||||||
|
# but slower streaming and more bandwidth.
|
||||||
|
OUTPUT_BIT_RATE=128
|
||||||
|
|
||||||
|
# Whether to allow song downloading.
|
||||||
|
# Note that if you're downloading more than one song, Koel will zip them up
|
||||||
|
# using PHP's ZipArchive. So if the module isn't available in the current
|
||||||
|
# environment, such a download will (silently) fail.
|
||||||
|
ALLOW_DOWNLOAD=true
|
||||||
|
|
||||||
|
# Whether to create a backup of a song instead of deleting it from the filesystem.
|
||||||
|
# If true, the song will simply be renamed into a .bak file.
|
||||||
|
BACKUP_ON_DELETE=true
|
||||||
|
|
||||||
|
# Koel attempts to detect if your website use HTTPS and generates secure URLs accordingly.
|
||||||
|
# If this attempt fails for any reason, you can force it by setting this value to true.
|
||||||
|
FORCE_HTTPS=
|
||||||
|
|
||||||
|
|
||||||
|
# Pusher configuration, for interesting features such as remote controlling.
|
||||||
|
PUSHER_APP_ID=
|
||||||
|
PUSHER_APP_KEY=
|
||||||
|
PUSHER_APP_SECRET=
|
||||||
|
PUSHER_APP_CLUSTER=
|
||||||
|
|
||||||
|
|
||||||
|
# The following settings are for Koel to send emails, for example to send user invitations and reset passwords.
|
||||||
|
MAIL_FROM_ADDRESS="__APP__@__DOMAIN__"
|
||||||
|
MAIL_FROM_NAME="${APP_NAME}"
|
||||||
|
MAIL_MAILER=smtp
|
||||||
|
MAIL_HOST=localhost
|
||||||
|
MAIL_PORT=25
|
||||||
|
MAIL_USERNAME=__APP__
|
||||||
|
MAIL_PASSWORD=__MAIL_PWD__
|
||||||
|
MAIL_ENCRYPTION=null
|
||||||
|
|
||||||
|
SQS_PUBLIC_KEY=
|
||||||
|
SQS_SECRET_KEY=
|
||||||
|
SQS_QUEUE_PREFIX=
|
||||||
|
SQS_QUEUE_NAME=
|
||||||
|
SQS_QUEUE_REGION=
|
||||||
|
|
||||||
|
# The variables below are Laravel-specific.
|
||||||
|
# You can change them if you know what you're doing. Otherwise, just leave them as-is.
|
||||||
|
BROADCAST_DRIVER=log
|
||||||
|
CACHE_DRIVER=file
|
||||||
|
FILESYSTEM_DISK=local
|
||||||
|
QUEUE_CONNECTION=sync
|
||||||
|
SESSION_DRIVER=file
|
||||||
|
SESSION_LIFETIME=120
|
||||||
5
conf/extra_php-fpm.conf
Normal file
5
conf/extra_php-fpm.conf
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
; Additional php.ini defines, specific to this pool of workers.
|
||||||
|
|
||||||
|
php_admin_value[upload_max_filesize] = 50M
|
||||||
|
php_admin_value[post_max_size] = 50M
|
||||||
|
php_admin_value[memory_limit] = 512M
|
||||||
|
|
@ -1,17 +1,20 @@
|
||||||
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
|
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
|
||||||
location __PATH__/ {
|
location ^~ __PATH__/ {
|
||||||
|
|
||||||
# Path to source
|
# Path to source
|
||||||
alias __INSTALL_DIR__/;
|
alias __INSTALL_DIR__/public/;
|
||||||
|
|
||||||
### Example PHP configuration (remove it if not used)
|
|
||||||
index index.php;
|
index index.php;
|
||||||
|
|
||||||
# Common parameter to increase upload size limit in conjunction with dedicated php-fpm file
|
try_files $uri $uri/ //index.php?$args;
|
||||||
#client_max_body_size 50M;
|
|
||||||
|
|
||||||
try_files $uri $uri/ index.php;
|
client_max_body_size 50M;
|
||||||
location ~ [^/]\.php(/|$) {
|
|
||||||
|
location __PATH__/media/ {
|
||||||
|
internal;
|
||||||
|
alias $upstream_http_x_media_root;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~* \.php$ {
|
||||||
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
|
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
|
||||||
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
|
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
|
||||||
|
|
||||||
|
|
@ -21,7 +24,6 @@ location __PATH__/ {
|
||||||
fastcgi_param PATH_INFO $fastcgi_path_info;
|
fastcgi_param PATH_INFO $fastcgi_path_info;
|
||||||
fastcgi_param SCRIPT_FILENAME $request_filename;
|
fastcgi_param SCRIPT_FILENAME $request_filename;
|
||||||
}
|
}
|
||||||
### End of PHP configuration part
|
|
||||||
|
|
||||||
# Include SSOWAT user panel.
|
# Include SSOWAT user panel.
|
||||||
include conf.d/yunohost_panel.conf.inc;
|
include conf.d/yunohost_panel.conf.inc;
|
||||||
|
|
|
||||||
|
|
@ -424,7 +424,7 @@ chdir = __INSTALL_DIR__
|
||||||
; php_admin_flag[mail.add_x_header] = Off
|
; php_admin_flag[mail.add_x_header] = Off
|
||||||
|
|
||||||
; Other common parameters
|
; Other common parameters
|
||||||
; php_admin_value[max_execution_time] = 600
|
php_admin_value[max_execution_time] = 600
|
||||||
; php_admin_value[max_input_time] = 300
|
php_admin_value[max_input_time] = 300
|
||||||
; php_admin_value[memory_limit] = 256M
|
php_admin_value[memory_limit] = 512M
|
||||||
; php_admin_flag[short_open_tag] = On
|
; php_admin_flag[short_open_tag] = On
|
||||||
|
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
[Unit]
|
|
||||||
Description=Small description of the service
|
|
||||||
After=network.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=__APP__
|
|
||||||
Group=__APP__
|
|
||||||
WorkingDirectory=__INSTALL_DIR__/
|
|
||||||
ExecStart=__INSTALL_DIR__/script
|
|
||||||
StandardOutput=append:/var/log/__APP__/__APP__.log
|
|
||||||
StandardError=inherit
|
|
||||||
|
|
||||||
# Sandboxing options to harden security
|
|
||||||
# Depending on specificities of your service/app, you may need to tweak these
|
|
||||||
# .. but this should be a good baseline
|
|
||||||
# Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html
|
|
||||||
NoNewPrivileges=yes
|
|
||||||
PrivateTmp=yes
|
|
||||||
PrivateDevices=yes
|
|
||||||
RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK
|
|
||||||
RestrictNamespaces=yes
|
|
||||||
RestrictRealtime=yes
|
|
||||||
DevicePolicy=closed
|
|
||||||
ProtectClock=yes
|
|
||||||
ProtectHostname=yes
|
|
||||||
ProtectProc=invisible
|
|
||||||
ProtectSystem=full
|
|
||||||
ProtectControlGroups=yes
|
|
||||||
ProtectKernelModules=yes
|
|
||||||
ProtectKernelTunables=yes
|
|
||||||
LockPersonality=yes
|
|
||||||
SystemCallArchitectures=native
|
|
||||||
SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged
|
|
||||||
|
|
||||||
# Denying access to capabilities that should not be relevant for webapps
|
|
||||||
# Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html
|
|
||||||
CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD
|
|
||||||
CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE
|
|
||||||
CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT
|
|
||||||
CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK
|
|
||||||
CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
|
|
||||||
CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
|
|
||||||
CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
|
|
||||||
CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
|
|
||||||
CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
@ -1,302 +0,0 @@
|
||||||
|
|
||||||
## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button
|
|
||||||
## Those panels let user configure some params on their apps using a friendly interface,
|
|
||||||
## and remove the need to manually edit files from the command line.
|
|
||||||
|
|
||||||
## From a packager perspective, this .toml is coupled to the scripts/config script,
|
|
||||||
## which may be used to define custom getters/setters. However, most use cases
|
|
||||||
## should be covered automagically by the core, thus it may not be necessary
|
|
||||||
## to define a scripts/config at all!
|
|
||||||
|
|
||||||
## -----------------------------------------------------------------------------
|
|
||||||
## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and
|
|
||||||
## do not overwhelm the admin with tons of misunderstandable or advanced settings.
|
|
||||||
## -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
## The top level describe the entire config panels screen.
|
|
||||||
|
|
||||||
## The version is a required property.
|
|
||||||
## Here a small reminder to associate config panel version with YunoHost version
|
|
||||||
## | Config | YNH | Config panel small change log |
|
|
||||||
## | ------ | --- | ------------------------------------------------------- |
|
|
||||||
## | 0.1 | 3.x | 0.1 config script not compatible with YNH >= 4.3 |
|
|
||||||
## | 1.0 | 4.3.x | The new config panel system with 'bind' property |
|
|
||||||
version = "1.0"
|
|
||||||
|
|
||||||
## (optional) i18n property let you internationalize questions, however this feature
|
|
||||||
## is only available in core configuration panel (like yunohost domain config).
|
|
||||||
## So in app config panel this key is ignored for now, but you can internationalize
|
|
||||||
## by using a lang dictionary (see property name bellow)
|
|
||||||
# i18n = "prefix_translation_key"
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
#### ABOUT PANELS
|
|
||||||
################################################################################
|
|
||||||
|
|
||||||
## The next level describes web admin panels
|
|
||||||
## You have to choose an ID for each panel, in this example the ID is "main"
|
|
||||||
## Keep in mind this ID will be used in CLI to refer to your question, so choose
|
|
||||||
## something short and meaningfull.
|
|
||||||
## In the webadmin, each panel corresponds to a distinct tab / form
|
|
||||||
[main]
|
|
||||||
|
|
||||||
## Define the label for your panel
|
|
||||||
## Internationalization works similarly to the 'description' and 'ask' questions in the manifest
|
|
||||||
# name.en = "Main configuration"
|
|
||||||
# name.fr = "Configuration principale"
|
|
||||||
|
|
||||||
## (optional) If you need to trigger a service reload-or-restart after the user
|
|
||||||
## change a question in this panel, you can add your service in the list.
|
|
||||||
services = ["__APP__"]
|
|
||||||
# or services = ["nginx", "__APP__"] to also reload-or-restart nginx
|
|
||||||
|
|
||||||
## (optional) This help properties is a short help displayed on the same line
|
|
||||||
## than the panel title but not displayed in the tab.
|
|
||||||
# help = ""
|
|
||||||
|
|
||||||
############################################################################
|
|
||||||
#### ABOUT SECTIONS
|
|
||||||
############################################################################
|
|
||||||
|
|
||||||
## A panel is composed of one or several sections.
|
|
||||||
##
|
|
||||||
## Sections are meant to group questions together when they correspond to
|
|
||||||
## a same subtopic. This impacts the rendering in terms of CLI prompts
|
|
||||||
## and HTML forms
|
|
||||||
##
|
|
||||||
## You should choose an ID for your section, and prefix it with the panel ID
|
|
||||||
## (Be sure to not make a typo in the panel ID, which would implicitly create
|
|
||||||
## an other entire panel)
|
|
||||||
##
|
|
||||||
## We use the context of pepettes_ynh as an example,
|
|
||||||
## which is a simple donation form app written in python,
|
|
||||||
## and for which the admin will want to edit the configuration
|
|
||||||
[main.customization]
|
|
||||||
|
|
||||||
## (optional) Defining a proper title for sections is not mandatory
|
|
||||||
## and depends on the exact rendering you're aiming for the CLI / webadmin
|
|
||||||
name = ""
|
|
||||||
|
|
||||||
## (optional) This help properties is a short help displayed on the same line
|
|
||||||
## than the section title, meant to provide additional details
|
|
||||||
# help = ""
|
|
||||||
|
|
||||||
## (optional) As for panel, you can specify to trigger a service
|
|
||||||
## reload-or-restart after the user change a question in this section.
|
|
||||||
## This property is added to the panel property, it doesn't deactivate it.
|
|
||||||
## So no need to replicate, the service list from panel services property.
|
|
||||||
# services = []
|
|
||||||
|
|
||||||
## (optional) By default all questions are optionals, but you can specify a
|
|
||||||
## default behaviour for question in the section
|
|
||||||
optional = false
|
|
||||||
|
|
||||||
## (optional) It's also possible with the 'visible' property to only
|
|
||||||
## display the section depending on the user's answers to previous questions.
|
|
||||||
##
|
|
||||||
## Be careful that the 'visible' property should only refer to **previous** questions
|
|
||||||
## Hence, it should not make sense to have a "visible" property on the very first section.
|
|
||||||
##
|
|
||||||
## Also, keep in mind that this feature only works in the webadmin and not in CLI
|
|
||||||
## (therefore a user could be prompted in CLI for a question that may not be relevant)
|
|
||||||
# visible = true
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
#### ABOUT QUESTIONS
|
|
||||||
########################################################################
|
|
||||||
|
|
||||||
## A section is compound of one or several questions.
|
|
||||||
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
## IMPORTANT: as for panel and section you have to choose an ID, but this
|
|
||||||
## one should be unique in all this document, even if the question is in
|
|
||||||
## an other panel.
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
|
|
||||||
## You can use same questions types and properties than in manifest.yml
|
|
||||||
## install part. However, in YNH 4.3, a lot of change has been made to
|
|
||||||
## extend availables questions types list.
|
|
||||||
## See: TODO DOC LINK
|
|
||||||
|
|
||||||
[main.customization.project_name]
|
|
||||||
|
|
||||||
## (required) The ask property is equivalent to the ask property in
|
|
||||||
## the manifest. However, in config panels, questions are displayed on the
|
|
||||||
## left side and therefore have less space to be rendered. Therefore,
|
|
||||||
## it is better to use a short question, and use the "help" property to
|
|
||||||
## provide additional details if necessary.
|
|
||||||
ask.en = "Name of the project"
|
|
||||||
|
|
||||||
## (required) The type property indicates how the question should be
|
|
||||||
## displayed, validated and managed. Some types have specific properties.
|
|
||||||
##
|
|
||||||
## Types available: string, boolean, number, range, text, password, path
|
|
||||||
## email, url, date, time, color, select, domain, user, tags, file.
|
|
||||||
##
|
|
||||||
## For a complete list with specific properties, see: TODO DOC LINK
|
|
||||||
type = "string"
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
#### ABOUT THE BIND PROPERTY
|
|
||||||
########################################################################
|
|
||||||
|
|
||||||
## (recommended) 'bind' property is a powerful feature that let you
|
|
||||||
## configure how and where the data will be read, validated and written.
|
|
||||||
|
|
||||||
## By default, 'bind property is in "settings" mode, it means it will
|
|
||||||
## **only** read and write the value in application settings file.
|
|
||||||
## bind = "settings"
|
|
||||||
|
|
||||||
## However, settings usually correspond to key/values in actual app configurations
|
|
||||||
## Hence, a more useful mode is to have bind = ":FILENAME". In that case, YunoHost
|
|
||||||
## will automagically find a line with "KEY=VALUE" in FILENAME
|
|
||||||
## (with the adequate separator between KEY and VALUE)
|
|
||||||
##
|
|
||||||
## YunoHost will then use this value for the read/get operation.
|
|
||||||
## During write/set operations, YunoHost will overwrite the value
|
|
||||||
## in **both** FILENAME and in the app's settings.yml
|
|
||||||
|
|
||||||
## Configuration file format supported: yaml, toml, json, ini, env, php,
|
|
||||||
## python. The feature probably works with others formats, but should be tested carefully.
|
|
||||||
|
|
||||||
## Note that this feature only works with relatively simple cases
|
|
||||||
## such as `KEY: VALUE`, but won't properly work with
|
|
||||||
## complex data structures like multilin array/lists or dictionnaries.
|
|
||||||
## It also doesn't work with XML format, custom config function call, php define(), ...
|
|
||||||
|
|
||||||
## More info on TODO
|
|
||||||
# bind = ":/var/www/__APP__/settings.py"
|
|
||||||
|
|
||||||
|
|
||||||
## By default, bind = ":FILENAME" will use the question ID as KEY
|
|
||||||
## ... but the question ID may sometime not be the exact KEY name in the configuration file.
|
|
||||||
##
|
|
||||||
## In particular, in pepettes, the python variable is 'name' and not 'project_name'
|
|
||||||
## (c.f. https://github.com/YunoHost-Apps/pepettes_ynh/blob/5cc2d3ffd6529cc7356ff93af92dbb6785c3ab9a/conf/settings.py##L11 )
|
|
||||||
##
|
|
||||||
## In that case, the key name can be specified before the column ':'
|
|
||||||
|
|
||||||
bind = "name:/var/www/__APP__/settings.py"
|
|
||||||
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
## IMPORTANT: other 'bind' mode exists:
|
|
||||||
##
|
|
||||||
## bind = "FILENAME" (with no column character before FILENAME)
|
|
||||||
## may be used to bind to the **entire file content** (instead of a single KEY/VALUE)
|
|
||||||
## This could be used to expose an entire configuration file, or binary files such as images
|
|
||||||
## For example:
|
|
||||||
## bind = "/var/www/__APP__/img/logo.png"
|
|
||||||
##
|
|
||||||
## bind = "null" can be used to disable reading / writing in settings.
|
|
||||||
## This creates sort of a "virtual" or "ephemeral" question which is not related to any actual setting
|
|
||||||
## In this mode, you are expected to define custom getter/setters/validators in scripts/config:
|
|
||||||
##
|
|
||||||
## getter: get__QUESTIONID()
|
|
||||||
## setter: set__QUESTIONID()
|
|
||||||
## validator: validate__QUESTIONID()
|
|
||||||
##
|
|
||||||
## You can also specify a common getter / setter / validator, with the
|
|
||||||
## function 'bind' mode, for example here it will try to run
|
|
||||||
## get__array_settings() first.
|
|
||||||
# bind = "array_settings()"
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
## IMPORTANT: with the exception of bind=null questions,
|
|
||||||
## question IDs should almost **always** correspond to an app setting
|
|
||||||
## initialized / reused during install/upgrade.
|
|
||||||
## Not doing so may result in inconsistencies between the config panel mechanism
|
|
||||||
## and the use of ynh_add_config
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
#### OTHER GENERIC PROPERTY FOR QUESTIONS
|
|
||||||
########################################################################
|
|
||||||
|
|
||||||
## (optional) An help text for the question
|
|
||||||
help = "Fill the name of the project which will received donation"
|
|
||||||
|
|
||||||
## (optional) An example display as placeholder in web form
|
|
||||||
# example = "YunoHost"
|
|
||||||
|
|
||||||
## (optional) set to true in order to redact the value in operation logs
|
|
||||||
# redact = false
|
|
||||||
|
|
||||||
## (optional) for boolean questions you can specify replacement values
|
|
||||||
## bound to true and false, in case property is bound to config file
|
|
||||||
# useful if bound property in config file expects something else than integer 1
|
|
||||||
yes = "Enable"
|
|
||||||
# useful if bound property in config file expects something else than integer 0
|
|
||||||
no = "Disable"
|
|
||||||
|
|
||||||
## (optional) A validation pattern
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
## IMPORTANT: your pattern should be between simple quote, not double.
|
|
||||||
## ---------------------------------------------------------------------
|
|
||||||
pattern.regexp = '^\w{3,30}$'
|
|
||||||
pattern.error = "The name should be at least 3 chars and less than 30 chars. Alphanumeric chars are accepted"
|
|
||||||
|
|
||||||
## Note: visible and optional properties are also available for questions
|
|
||||||
|
|
||||||
|
|
||||||
[main.customization.contact_url]
|
|
||||||
ask = "Contact url"
|
|
||||||
type = "url"
|
|
||||||
example = "mailto: contact@example.org"
|
|
||||||
help = "mailto: accepted"
|
|
||||||
pattern.regexp = '^mailto:[^@]+@[^@]+|https://$'
|
|
||||||
pattern.error = "Should be https or mailto:"
|
|
||||||
bind = ":/var/www/__APP__/settings.py"
|
|
||||||
|
|
||||||
[main.customization.logo]
|
|
||||||
ask = "Logo"
|
|
||||||
type = "file"
|
|
||||||
accept = ".png"
|
|
||||||
help = "Fill with an already resized logo"
|
|
||||||
bind = "__INSTALL_DIR__/img/logo.png"
|
|
||||||
|
|
||||||
[main.customization.favicon]
|
|
||||||
ask = "Favicon"
|
|
||||||
type = "file"
|
|
||||||
accept = ".png"
|
|
||||||
help = "Fill with an already sized favicon"
|
|
||||||
bind = "__INSTALL_DIR__/img/favicon.png"
|
|
||||||
|
|
||||||
|
|
||||||
[main.stripe]
|
|
||||||
name = "Stripe general info"
|
|
||||||
optional = false
|
|
||||||
|
|
||||||
# The next alert is overwrited with a getter from the config script
|
|
||||||
[main.stripe.amount]
|
|
||||||
ask = "Donation in the month : XX €
|
|
||||||
type = "alert"
|
|
||||||
style = "success"
|
|
||||||
|
|
||||||
[main.stripe.publishable_key]
|
|
||||||
ask = "Publishable key"
|
|
||||||
type = "string"
|
|
||||||
redact = true
|
|
||||||
help = "Indicate here the stripe publishable key"
|
|
||||||
bind = ":/var/www/__APP__/settings.py"
|
|
||||||
|
|
||||||
[main.stripe.secret_key]
|
|
||||||
ask = "Secret key"
|
|
||||||
type = "string"
|
|
||||||
redact = true
|
|
||||||
help = "Indicate here the stripe secret key"
|
|
||||||
bind = ":/var/www/__APP__/settings.py"
|
|
||||||
|
|
||||||
[main.stripe.prices]
|
|
||||||
ask = "Prices ID"
|
|
||||||
type = "tags"
|
|
||||||
help = """\
|
|
||||||
Indicates here the prices ID of donation products you created in stripe interfaces. \
|
|
||||||
Go on [Stripe products](https://dashboard.stripe.com/products) to create those donation products. \
|
|
||||||
Fill it tag with 'FREQUENCY/CURRENCY/PRICE_ID' \
|
|
||||||
FREQUENCY: 'one_time' or 'recuring' \
|
|
||||||
CURRENCY: 'EUR' or 'USD' \
|
|
||||||
PRICE_ID: ID from stripe interfaces starting with 'price_' \
|
|
||||||
"""
|
|
||||||
pattern.regexp = '^(one_time|recuring)/(EUR|USD)/price_.*$'
|
|
||||||
pattern.error = "Please respect the format describe in help text for each price ID"
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
This is a dummy admin doc for this app
|
__APP__'s data directory is located at `__DATA_DIR__` and symlinked to `/home/yunohost.multimedia/__APP__`
|
||||||
|
for easy access to users and other multimedia applications.
|
||||||
|
|
||||||
The app install dir is `__INSTALL_DIR__`
|
You may change it in Koel's configuration page, for instance into `/home/yunohost.multimedia/share/Music`.
|
||||||
|
If you change it, `__DATA_DIR__` will still be the directory to be backed up.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
Ceci est une fausse doc d'admin pour cette app
|
|
||||||
|
|
||||||
Le dossier d'install de l'app est `__INSTALL_DIR__`
|
|
||||||
|
|
@ -1 +1,3 @@
|
||||||
This is a dummy description of this app features
|
Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side.
|
||||||
|
|
||||||
|
Targeting web developers, Koel embraces some of the more modern web technologies to do its job.
|
||||||
|
|
|
||||||
|
|
@ -1 +1,3 @@
|
||||||
Ceci est une fausse description des fonctionalités de l'app
|
Un simple service web de streaming audio personnel, écrit en Vue pour le client et en Laravel pour le serveur.
|
||||||
|
|
||||||
|
Destiné aux développeurs web, Koel utilise certaines des technologies web les plus modernes pour accomplir son travail.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1 @@
|
||||||
This is a dummy disclaimer to display after the install
|
Default admin credentials are `admin@koel.dev` as username and `KoelIsCool` as password. Log in, and change them!
|
||||||
|
|
||||||
The app url is `__DOMAIN____PATH__`
|
|
||||||
|
|
||||||
The app install dir is `__INSTALL_DIR__`
|
|
||||||
|
|
||||||
The app id is `__ID__`
|
|
||||||
|
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
This is a dummy disclaimer to display after upgrades
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
This is a dummy disclaimer to display prior to the install
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Ceci est un faux disclaimer à présenter avant l'installation
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
This is a dummy disclaimer to display prior to any upgrade
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 35 KiB |
BIN
doc/screenshots/showcase.png
Normal file
BIN
doc/screenshots/showcase.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 425 KiB |
102
manifest.toml
102
manifest.toml
|
|
@ -2,120 +2,66 @@
|
||||||
|
|
||||||
packaging_format = 2
|
packaging_format = 2
|
||||||
|
|
||||||
id = "example"
|
id = "koel"
|
||||||
name = "Example app"
|
name = "Koel"
|
||||||
description.en = "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)"
|
description.en = "A simple web-based personal audio streaming service."
|
||||||
description.fr = "Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)"
|
description.fr = "Un simple service web de streaming audio personnel."
|
||||||
|
|
||||||
version = "1.0~ynh1"
|
version = "6.11.2~ynh1"
|
||||||
|
|
||||||
maintainers = ["johndoe"]
|
maintainers = ["tituspijean"]
|
||||||
|
|
||||||
[upstream]
|
[upstream]
|
||||||
# NB: Only the "license" key is mandatory. Remove entries for which there's no relevant data
|
license = "MIT"
|
||||||
license = "free"
|
website = "https://koel.dev"
|
||||||
website = "https://example.com"
|
demo = "https://demo.koel.dev"
|
||||||
demo = "https://demo.example.com"
|
admindoc = "https://docs.koel.dev"
|
||||||
admindoc = "https://yunohost.org/packaging_apps"
|
code = "https://github.com/koel/koel"
|
||||||
userdoc = "https://yunohost.org/apps"
|
cpe = "cpe:2.3:a:koel:koel"
|
||||||
code = "https://some.forge.com/example/example"
|
fund = "https://opencollective.com/koel"
|
||||||
# FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, YunoHost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number)
|
|
||||||
cpe = "???"
|
|
||||||
# FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin.
|
|
||||||
fund = "???"
|
|
||||||
|
|
||||||
[integration]
|
[integration]
|
||||||
yunohost = ">= 11.1.21"
|
yunohost = ">= 11.1.21"
|
||||||
# FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"]
|
|
||||||
architectures = "all"
|
architectures = "all"
|
||||||
multi_instance = true
|
multi_instance = true
|
||||||
# FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key: the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials.
|
ldap = false
|
||||||
ldap = "?"
|
sso = false
|
||||||
# FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key: the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal.
|
|
||||||
sso = "?"
|
|
||||||
# FIXME: replace with an **estimate** minimum disk and RAM requirements. e.g. 20M, 400M, 1G...
|
|
||||||
disk = "50M"
|
disk = "50M"
|
||||||
ram.build = "50M"
|
ram.build = "50M"
|
||||||
ram.runtime = "50M"
|
ram.runtime = "50M"
|
||||||
|
|
||||||
[install]
|
[install]
|
||||||
[install.domain]
|
[install.domain]
|
||||||
# this is a generic question - ask strings are automatically handled by YunoHost's core
|
|
||||||
type = "domain"
|
type = "domain"
|
||||||
|
|
||||||
[install.path]
|
|
||||||
# this is a generic question - ask strings are automatically handled by YunoHost's core
|
|
||||||
type = "path"
|
|
||||||
default = "/example"
|
|
||||||
|
|
||||||
[install.init_main_permission]
|
[install.init_main_permission]
|
||||||
# this is a generic question - ask strings are automatically handled by YunoHost's core
|
|
||||||
# This won't be saved as setting and will instead be used to initialize the SSOwat permission
|
|
||||||
type = "group"
|
type = "group"
|
||||||
default = "visitors"
|
default = "visitors"
|
||||||
|
|
||||||
[install.language]
|
|
||||||
ask.en = "Choose the application language"
|
|
||||||
ask.fr = "Choisissez la langue de l'application"
|
|
||||||
type = "select"
|
|
||||||
choices = ["fr", "en"]
|
|
||||||
default = "fr"
|
|
||||||
|
|
||||||
[install.admin]
|
|
||||||
# this is a generic question - ask strings are automatically handled by YunoHost's core
|
|
||||||
type = "user"
|
|
||||||
|
|
||||||
[install.password]
|
|
||||||
# this is a generic question - ask strings are automatically handled by YunoHost's core
|
|
||||||
# Note that user-provided passwords questions are not automatically saved as setting
|
|
||||||
help.en = "Use the help field to add an information for the admin about this question."
|
|
||||||
help.fr = "Utilisez le champ aide pour ajouter une information à l'intention de l'administrateur à propos de cette question."
|
|
||||||
type = "password"
|
|
||||||
|
|
||||||
[resources]
|
[resources]
|
||||||
# See the packaging documentation for the full set
|
|
||||||
# of explanation regarding the behavior and properties for each of those
|
|
||||||
|
|
||||||
[resources.sources]
|
[resources.sources]
|
||||||
|
|
||||||
[resources.sources.main]
|
[resources.sources.main]
|
||||||
# This will pre-fetch the asset which can then be deployed during the install/upgrade scripts with :
|
url = "https://github.com/koel/koel/releases/download/v6.11.2/koel-v6.11.2.tar.gz"
|
||||||
# ynh_setup_source --dest_dir="$install_dir"
|
sha256 = "db344b927be7a403712c3f4198288c01792dd1dc54af9b76b4ea16d6e62e5dc7"
|
||||||
# You can also define other assets than "main" and add --source_id="foobar" in the previous command
|
|
||||||
url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.tar.gz"
|
|
||||||
sha256 = "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
|
|
||||||
|
|
||||||
# These infos are used by https://github.com/YunoHost/apps/blob/master/tools/autoupdate_app_sources/autoupdate_app_sources.py
|
autoupdate.strategy = "latest_github_release"
|
||||||
# to auto-update the previous asset urls and sha256sum + manifest version
|
|
||||||
# assuming the upstream's code repo is on github and relies on tags or releases
|
|
||||||
# See the 'sources' resource documentation for more details
|
|
||||||
|
|
||||||
# autoupdate.strategy = "latest_github_tag"
|
|
||||||
|
|
||||||
[resources.system_user]
|
[resources.system_user]
|
||||||
# This will provision/deprovision a unix system user
|
allow_email = true
|
||||||
|
|
||||||
[resources.install_dir]
|
[resources.install_dir]
|
||||||
# This will create/remove the install dir as /var/www/$app
|
|
||||||
# and store the corresponding setting $install_dir
|
|
||||||
|
|
||||||
[resources.data_dir]
|
[resources.data_dir]
|
||||||
# This will create/remove the data dir as /home/yunohost.app/$app
|
|
||||||
# and store the corresponding setting $data_dir
|
|
||||||
|
|
||||||
[resources.permissions]
|
|
||||||
# This will configure SSOwat permission for $domain/$path/
|
|
||||||
# The initial allowed group of user is configured via the init_main_permission question (public=visitors, private=all_users)
|
|
||||||
main.url = "/"
|
|
||||||
|
|
||||||
[resources.ports]
|
[resources.ports]
|
||||||
# This will pick a random port for reverse-proxying and store it as the $port setting
|
|
||||||
|
[resources.permissions]
|
||||||
|
main.url = "/"
|
||||||
|
|
||||||
[resources.apt]
|
[resources.apt]
|
||||||
# This will automatically install/uninstall the following apt packages
|
packages = "php8.2-fpm, php8.2-mysql, php8.2-sqlite3, php8.2-xml, php8.2-mbstring, mariadb-server, ffmpeg"
|
||||||
# and implicitly define the $phpversion setting as 8.0 (if phpX.Y-foobar dependencies are listed)
|
|
||||||
packages = "deb1, deb2, php8.0-foo, php8.0-bar"
|
|
||||||
|
|
||||||
[resources.database]
|
[resources.database]
|
||||||
# This will automatically provision/deprovison a MySQL DB and store the corresponding credentials in settings $db_user, $db_name, $db_pwd
|
|
||||||
type = "mysql"
|
type = "mysql"
|
||||||
|
|
|
||||||
|
|
@ -15,11 +15,6 @@ source /usr/share/yunohost/helpers
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_print_info --message="Declaring files to be backed up..."
|
ynh_print_info --message="Declaring files to be backed up..."
|
||||||
|
|
||||||
### N.B. : the following 'ynh_backup' calls are only a *declaration* of what needs
|
|
||||||
### to be backuped and not an actual copy of any file. The actual backup that
|
|
||||||
### creates and fill the archive with the files happens in the core after this
|
|
||||||
### script is called. Hence ynh_backups calls takes basically 0 seconds to run.
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP THE APP MAIN DIR
|
# BACKUP THE APP MAIN DIR
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -30,7 +25,6 @@ ynh_backup --src_path="$install_dir"
|
||||||
# BACKUP THE DATA DIR
|
# BACKUP THE DATA DIR
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
# Only relevant if there is a "data_dir" resource for this app
|
|
||||||
ynh_backup --src_path="$data_dir" --is_big
|
ynh_backup --src_path="$data_dir" --is_big
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -45,43 +39,17 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
|
ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# BACKUP FAIL2BAN CONFIGURATION
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
ynh_backup --src_path="/etc/fail2ban/jail.d/$app.conf"
|
|
||||||
ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# SPECIFIC BACKUP
|
# SPECIFIC BACKUP
|
||||||
#=================================================
|
|
||||||
# BACKUP LOGROTATE
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
ynh_backup --src_path="/etc/logrotate.d/$app"
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# BACKUP SYSTEMD
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
ynh_backup --src_path="/etc/systemd/system/$app.service"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP VARIOUS FILES
|
# BACKUP VARIOUS FILES
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
ynh_backup --src_path="/etc/cron.d/$app"
|
|
||||||
|
|
||||||
ynh_backup --src_path="/etc/$app/"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP THE MYSQL DATABASE
|
# BACKUP THE MYSQL DATABASE
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_print_info --message="Backing up the MySQL database..."
|
ynh_print_info --message="Backing up the MySQL database..."
|
||||||
|
|
||||||
### (However, things like MySQL dumps *do* take some time to run, though the
|
|
||||||
### copy of the generated dump to the archive still happens later)
|
|
||||||
|
|
||||||
ynh_mysql_dump_db --database="$db_name" > db.sql
|
ynh_mysql_dump_db --database="$db_name" > db.sql
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
|
||||||
|
|
@ -11,13 +11,6 @@ source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# STANDARD MODIFICATIONS
|
# STANDARD MODIFICATIONS
|
||||||
#=================================================
|
|
||||||
# STOP SYSTEMD SERVICE
|
|
||||||
#=================================================
|
|
||||||
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"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# MODIFY URL IN NGINX CONF
|
# MODIFY URL IN NGINX CONF
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -34,11 +27,6 @@ ynh_change_url_nginx_config
|
||||||
#=================================================
|
#=================================================
|
||||||
# GENERIC FINALISATION
|
# GENERIC FINALISATION
|
||||||
#=================================================
|
#=================================================
|
||||||
# START SYSTEMD SERVICE
|
|
||||||
#=================================================
|
|
||||||
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
||||||
|
|
||||||
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# END OF SCRIPT
|
# END OF SCRIPT
|
||||||
|
|
|
||||||
102
scripts/config
102
scripts/config
|
|
@ -1,102 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
# In simple cases, you don't need a config script.
|
|
||||||
|
|
||||||
# With a simple config_panel.toml, you can write in the app settings, in the
|
|
||||||
# upstream config file or replace complete files (logo ...) and restart services.
|
|
||||||
|
|
||||||
# The config scripts allows you to go further, to handle specific cases
|
|
||||||
# (validation of several interdependent fields, specific getter/setter for a value,
|
|
||||||
# display dynamic informations or choices, pre-loading of config type .cube... ).
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# GENERIC STARTING
|
|
||||||
#=================================================
|
|
||||||
# IMPORT GENERIC HELPERS
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
source /usr/share/yunohost/helpers
|
|
||||||
|
|
||||||
ynh_abort_if_errors
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# RETRIEVE ARGUMENTS
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# SPECIFIC GETTERS FOR TOML SHORT KEY
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
get__amount() {
|
|
||||||
# Here we can imagine to have an API call to stripe to know the amount of donation during a month
|
|
||||||
local amount = 200
|
|
||||||
|
|
||||||
# It's possible to change some properties of the question by overriding it:
|
|
||||||
if [ $amount -gt 100 ]
|
|
||||||
then
|
|
||||||
cat << EOF
|
|
||||||
style: success
|
|
||||||
value: $amount
|
|
||||||
ask:
|
|
||||||
en: A lot of donation this month: **$amount €**
|
|
||||||
EOF
|
|
||||||
else
|
|
||||||
cat << EOF
|
|
||||||
style: danger
|
|
||||||
value: $amount
|
|
||||||
ask:
|
|
||||||
en: Not so much donation this month: $amount €
|
|
||||||
EOF
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
get__prices() {
|
|
||||||
local prices = "$(grep "DONATION\['" "$install_dir/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')"
|
|
||||||
if [ "$prices" == "," ];
|
|
||||||
then
|
|
||||||
# Return YNH_NULL if you prefer to not return a value at all.
|
|
||||||
echo YNH_NULL
|
|
||||||
else
|
|
||||||
echo $prices
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# SPECIFIC VALIDATORS FOR TOML SHORT KEYS
|
|
||||||
#=================================================
|
|
||||||
validate__publishable_key() {
|
|
||||||
|
|
||||||
# We can imagine here we test if the key is really a publisheable key
|
|
||||||
(is_secret_key $publishable_key) &&
|
|
||||||
echo 'This key seems to be a secret key'
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# SPECIFIC SETTERS FOR TOML SHORT KEYS
|
|
||||||
#=================================================
|
|
||||||
set__prices() {
|
|
||||||
|
|
||||||
#---------------------------------------------
|
|
||||||
# IMPORTANT: setter are trigger only if a change is detected
|
|
||||||
#---------------------------------------------
|
|
||||||
for price in $(echo $prices | sed "s/,/ /"); do
|
|
||||||
frequency=$(echo $price | cut -d/ -f1)
|
|
||||||
currency=$(echo $price | cut -d/ -f2)
|
|
||||||
price_id=$(echo $price | cut -d/ -f3)
|
|
||||||
sed "d/DONATION\['$frequency'\]\['$currency'\]" "$install_dir/settings.py"
|
|
||||||
|
|
||||||
echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$install_dir/settings.py"
|
|
||||||
done
|
|
||||||
|
|
||||||
#---------------------------------------------
|
|
||||||
# IMPORTANT: to be able to upgrade properly, you have to saved the value in settings too
|
|
||||||
#---------------------------------------------
|
|
||||||
ynh_app_setting_set $app prices $prices
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# GENERIC FINALIZATION
|
|
||||||
#=================================================
|
|
||||||
ynh_app_config_run $1
|
|
||||||
170
scripts/install
170
scripts/install
|
|
@ -9,27 +9,6 @@
|
||||||
source _common.sh
|
source _common.sh
|
||||||
source /usr/share/yunohost/helpers
|
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)
|
|
||||||
#
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# APP "BUILD" (DEPLOYING SOURCES, VENV, COMPILING ETC)
|
# APP "BUILD" (DEPLOYING SOURCES, VENV, COMPILING ETC)
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -37,94 +16,19 @@ source /usr/share/yunohost/helpers
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Setting up source files..." --weight=1
|
ynh_script_progression --message="Setting up source files..." --weight=1
|
||||||
|
|
||||||
### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
|
|
||||||
### downloaded from an upstream source, like a git repository.
|
|
||||||
### `ynh_setup_source` use the file conf/app.src
|
|
||||||
|
|
||||||
# Download, check integrity, uncompress and patch the source from app.src
|
|
||||||
ynh_setup_source --dest_dir="$install_dir"
|
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"
|
chown -R $app:www-data "$install_dir"
|
||||||
|
chown -R $app:www-data "$data_dir"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# SYSTEM CONFIGURATION
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||||||
#=================================================
|
#================================================
|
||||||
ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
|
ynh_script_progression --message="Initializing multimedia directories..." --weight=1
|
||||||
|
|
||||||
### `ynh_add_fpm_config` is used to set up a PHP config.
|
ynh_multimedia_build_main_dir
|
||||||
### You can remove it if your app doesn't use PHP.
|
ynh_multimedia_addfolder --source_dir="$data_dir" --dest_dir="$app"
|
||||||
### `ynh_add_fpm_config` will use the files conf/php-fpm.conf
|
ynh_multimedia_addaccess $app
|
||||||
### If you're not using these lines:
|
|
||||||
### - You can remove these files in conf/.
|
|
||||||
### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup 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
|
|
||||||
### with the reload at the end of the script.
|
|
||||||
### - And the section "PHP-FPM CONFIGURATION" in the upgrade script
|
|
||||||
|
|
||||||
# Create a dedicated PHP-FPM config using the conf/php-fpm.conf or conf/extra_php-fpm.conf
|
|
||||||
ynh_add_fpm_config
|
|
||||||
|
|
||||||
# Create a dedicated NGINX config using the conf/nginx.conf template
|
|
||||||
ynh_add_nginx_config
|
|
||||||
|
|
||||||
### `ynh_systemd_config` 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_systemd_config` will use the file conf/systemd.service
|
|
||||||
### If you're not using these lines:
|
|
||||||
### - You can remove those files in conf/.
|
|
||||||
### - Remove the section "BACKUP SYSTEMD" in the backup script
|
|
||||||
### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script
|
|
||||||
### - As well as the section "RESTORE SYSTEMD" in the restore script
|
|
||||||
### - And the section "SETUP SYSTEMD" in the upgrade script
|
|
||||||
|
|
||||||
# Create a dedicated systemd config
|
|
||||||
ynh_add_systemd_config
|
|
||||||
|
|
||||||
### `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!)
|
|
||||||
### If you're not using these lines:
|
|
||||||
### - You can remove these files in conf/.
|
|
||||||
### - Remove the section "REMOVE SERVICE INTEGRATION IN YUNOHOST" in the remove script
|
|
||||||
### - As well as the section "INTEGRATE SERVICE IN YUNOHOST" in the restore script
|
|
||||||
### - And the section "INTEGRATE SERVICE IN YUNOHOST" in the upgrade script
|
|
||||||
|
|
||||||
yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
|
|
||||||
|
|
||||||
### 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 is 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)
|
|
||||||
|
|
||||||
### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
|
|
||||||
### Use this helper only if there is effectively a log file for this app.
|
|
||||||
### If you're not using this helper:
|
|
||||||
### - Remove the section "BACKUP LOGROTATE" in the backup script
|
|
||||||
### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
|
|
||||||
### - As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script
|
|
||||||
### - And the section "SETUP LOGROTATE" in the upgrade script
|
|
||||||
|
|
||||||
# Use logrotate to manage application logfile(s)
|
|
||||||
ynh_use_logrotate
|
|
||||||
|
|
||||||
# Create a dedicated Fail2Ban config
|
|
||||||
ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# APP INITIAL CONFIGURATION
|
# APP INITIAL CONFIGURATION
|
||||||
|
|
@ -133,63 +37,27 @@ ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failreg
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
||||||
|
|
||||||
### You can add specific configuration files.
|
app_key=$(ynh_string_random --length=32)
|
||||||
###
|
ynh_app_setting_set --app="$app" --key="app_key" --value="$app_key"
|
||||||
### Typically, put your template conf file in ../conf/your_config_file
|
ynh_add_config --template="env" --destination="$install_dir/.env"
|
||||||
### 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_add_config 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_add_config` for more info.
|
|
||||||
|
|
||||||
ynh_add_config --template="some_config_file" --destination="$install_dir/some_config_file"
|
|
||||||
|
|
||||||
# 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/some_config_file"
|
|
||||||
chown $app:$app "$install_dir/some_config_file"
|
|
||||||
|
|
||||||
### 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/some_config_file"
|
|
||||||
### ynh_store_file_checksum --file="$install_dir/some_config_file"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# SETUP APPLICATION WITH CURL
|
# INITIALIZE THE APP
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Initializing Koel..." --weight=1
|
||||||
|
|
||||||
### Use these lines only if the app installation needs to be finalized through
|
pushd $install_dir
|
||||||
### web forms. We generally don't want to ask the final user,
|
ynh_exec_as $app php$phpversion artisan koel:init --no-assets --no-interaction --quiet
|
||||||
### so we're going to use curl to automatically fill the fields and submit the
|
popd
|
||||||
### forms.
|
|
||||||
|
|
||||||
# Installation with curl
|
|
||||||
ynh_script_progression --message="Finalizing installation..." --weight=1
|
|
||||||
ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# GENERIC FINALIZATION
|
# SYSTEM CONFIGURATION
|
||||||
#=================================================
|
#=================================================
|
||||||
# START SYSTEMD SERVICE
|
ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
|
||||||
#=================================================
|
|
||||||
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
||||||
|
|
||||||
### `ynh_systemd_action` is used to start a systemd service for an app.
|
ynh_add_fpm_config
|
||||||
### 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
|
|
||||||
|
|
||||||
# Start a systemd service
|
ynh_add_nginx_config
|
||||||
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# END OF SCRIPT
|
# END OF SCRIPT
|
||||||
|
|
|
||||||
|
|
@ -9,52 +9,15 @@
|
||||||
source _common.sh
|
source _common.sh
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
# Settings are automatically loaded as bash variables
|
|
||||||
# in every app script context, therefore typically these will exist:
|
|
||||||
# - $domain
|
|
||||||
# - $path
|
|
||||||
# - $language
|
|
||||||
# - $install_dir
|
|
||||||
# - $port
|
|
||||||
# ...
|
|
||||||
|
|
||||||
# For remove operations :
|
|
||||||
# - the core will deprovision every resource defined in the manifest **after** this script is ran
|
|
||||||
# this includes removing the install directory, and data directory (if --purge was used)
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# REMOVE SYSTEM CONFIGURATIONS
|
# REMOVE SYSTEM CONFIGURATIONS
|
||||||
#=================================================
|
#=================================================
|
||||||
# REMOVE SYSTEMD SERVICE
|
|
||||||
#=================================================
|
|
||||||
ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
|
|
||||||
|
|
||||||
# This should be a symetric version of what happens in the install script
|
|
||||||
|
|
||||||
# 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
|
|
||||||
then
|
|
||||||
ynh_script_progression --message="Removing $app service integration..." --weight=1
|
|
||||||
yunohost service remove $app
|
|
||||||
fi
|
|
||||||
|
|
||||||
ynh_remove_systemd_config
|
|
||||||
|
|
||||||
ynh_remove_nginx_config
|
ynh_remove_nginx_config
|
||||||
|
|
||||||
ynh_remove_fpm_config
|
ynh_remove_fpm_config
|
||||||
|
|
||||||
ynh_remove_logrotate
|
ynh_secure_remove --file="/home/yunohost.multimedia/$app"
|
||||||
|
|
||||||
ynh_remove_fail2ban_config
|
|
||||||
|
|
||||||
# Remove other various files specific to the app... such as :
|
|
||||||
|
|
||||||
ynh_secure_remove --file="/etc/cron.d/$app"
|
|
||||||
|
|
||||||
ynh_secure_remove --file="/etc/$app"
|
|
||||||
|
|
||||||
ynh_secure_remove --file="/var/log/$app"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# END OF SCRIPT
|
# END OF SCRIPT
|
||||||
|
|
|
||||||
|
|
@ -17,9 +17,6 @@ ynh_script_progression --message="Restoring the app main directory..." --weight=
|
||||||
|
|
||||||
ynh_restore_file --origin_path="$install_dir"
|
ynh_restore_file --origin_path="$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"
|
chown -R $app:www-data "$install_dir"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -29,9 +26,17 @@ ynh_script_progression --message="Restoring the data directory..." --weight=1
|
||||||
|
|
||||||
ynh_restore_file --origin_path="$data_dir" --not_mandatory
|
ynh_restore_file --origin_path="$data_dir" --not_mandatory
|
||||||
|
|
||||||
# (Same as for install dir)
|
|
||||||
chown -R $app:www-data "$data_dir"
|
chown -R $app:www-data "$data_dir"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RESTORING MULTIMEDIA DIRECTORIES
|
||||||
|
#================================================
|
||||||
|
ynh_script_progression --message="Restoring multimedia directories..." --weight=1
|
||||||
|
|
||||||
|
ynh_multimedia_build_main_dir
|
||||||
|
ynh_multimedia_addfolder --source_dir="$data_dir" --dest_dir="$app"
|
||||||
|
ynh_multimedia_addaccess $app
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# RESTORE THE MYSQL DATABASE
|
# RESTORE THE MYSQL DATABASE
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -46,28 +51,10 @@ ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
|
ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
|
||||||
|
|
||||||
# This should be a symetric version of what happens in the install script
|
|
||||||
|
|
||||||
ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
|
ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
|
||||||
|
|
||||||
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
|
|
||||||
systemctl enable $app.service --quiet
|
|
||||||
|
|
||||||
yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
|
|
||||||
|
|
||||||
ynh_restore_file --origin_path="/etc/logrotate.d/$app"
|
|
||||||
|
|
||||||
ynh_restore_file --origin_path="/etc/fail2ban/jail.d/$app.conf"
|
|
||||||
ynh_restore_file --origin_path="/etc/fail2ban/filter.d/$app.conf"
|
|
||||||
ynh_systemd_action --action=restart --service_name=fail2ban
|
|
||||||
|
|
||||||
# Other various files...
|
|
||||||
|
|
||||||
ynh_restore_file --origin_path="/etc/cron.d/$app"
|
|
||||||
ynh_restore_file --origin_path="/etc/$app/"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# GENERIC FINALIZATION
|
# GENERIC FINALIZATION
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -76,7 +63,6 @@ ynh_restore_file --origin_path="/etc/$app/"
|
||||||
ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
|
ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
|
||||||
|
|
||||||
# Typically you only have either $app or php-fpm but not both at the same time...
|
# Typically you only have either $app or php-fpm but not both at the same time...
|
||||||
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
||||||
ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
|
ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
|
||||||
|
|
||||||
ynh_systemd_action --service_name=nginx --action=reload
|
ynh_systemd_action --service_name=nginx --action=reload
|
||||||
|
|
|
||||||
|
|
@ -9,25 +9,6 @@
|
||||||
source _common.sh
|
source _common.sh
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
# Settings are automatically loaded as bash variables
|
|
||||||
# in every app script context, therefore typically these will exist:
|
|
||||||
# - $domain
|
|
||||||
# - $path
|
|
||||||
# - $language
|
|
||||||
# - $install_dir
|
|
||||||
# - $port
|
|
||||||
# ...
|
|
||||||
|
|
||||||
# In the context of upgrade,
|
|
||||||
# - resources are automatically provisioned / updated / deleted (depending on existing resources)
|
|
||||||
# - a safety backup is automatically created by the core and will be restored if the upgrade fails
|
|
||||||
|
|
||||||
### This helper will compare the version of the currently installed app and the version of the upstream package.
|
|
||||||
### $upgrade_type can have 2 different values
|
|
||||||
### - UPGRADE_APP if the upstream app version has changed
|
|
||||||
### - UPGRADE_PACKAGE if only the YunoHost package has changed
|
|
||||||
### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
|
|
||||||
### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
|
|
||||||
upgrade_type=$(ynh_check_app_version_changed)
|
upgrade_type=$(ynh_check_app_version_changed)
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -35,32 +16,6 @@ upgrade_type=$(ynh_check_app_version_changed)
|
||||||
#=================================================
|
#=================================================
|
||||||
# ENSURE DOWNWARD COMPATIBILITY
|
# ENSURE DOWNWARD COMPATIBILITY
|
||||||
#=================================================
|
#=================================================
|
||||||
#ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
|
|
||||||
|
|
||||||
#
|
|
||||||
# N.B. : the followings setting migrations snippets are provided as *EXAMPLES*
|
|
||||||
# of what you may want to do in some cases (e.g. a setting was not defined on
|
|
||||||
# some legacy installs and you therefore want to initiaze stuff during upgrade)
|
|
||||||
#
|
|
||||||
|
|
||||||
# If db_name doesn't exist, create it
|
|
||||||
#if [ -z "$db_name" ]; then
|
|
||||||
# db_name=$(ynh_sanitize_dbid --db_name=$app)
|
|
||||||
# ynh_app_setting_set --app=$app --key=db_name --value=$db_name
|
|
||||||
#fi
|
|
||||||
|
|
||||||
# If install_dir doesn't exist, create it
|
|
||||||
#if [ -z "$install_dir" ]; then
|
|
||||||
# install_dir=/var/www/$app
|
|
||||||
# ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
|
|
||||||
#fi
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# STOP SYSTEMD SERVICE
|
|
||||||
#=================================================
|
|
||||||
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"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# "REBUILD" THE APP (DEPLOY NEW SOURCES, RERUN NPM BUILD...)
|
# "REBUILD" THE APP (DEPLOY NEW SOURCES, RERUN NPM BUILD...)
|
||||||
|
|
@ -76,9 +31,6 @@ then
|
||||||
ynh_setup_source --dest_dir="$install_dir"
|
ynh_setup_source --dest_dir="$install_dir"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# $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"
|
chown -R $app:www-data "$install_dir"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -86,54 +38,10 @@ chown -R $app:www-data "$install_dir"
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
|
ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
|
||||||
|
|
||||||
# This should be a literal copypasta of what happened in the install's "System configuration" section
|
|
||||||
|
|
||||||
ynh_add_fpm_config
|
ynh_add_fpm_config
|
||||||
|
|
||||||
ynh_add_nginx_config
|
ynh_add_nginx_config
|
||||||
|
|
||||||
ynh_add_systemd_config
|
|
||||||
|
|
||||||
yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
|
|
||||||
|
|
||||||
ynh_use_logrotate --non-append
|
|
||||||
|
|
||||||
ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...)
|
|
||||||
#=================================================
|
|
||||||
# UPDATE A CONFIG FILE
|
|
||||||
#=================================================
|
|
||||||
ynh_script_progression --message="Updating a configuration file..." --weight=1
|
|
||||||
|
|
||||||
### Same as during install
|
|
||||||
###
|
|
||||||
### The file will automatically be backed-up if it's found to be manually modified (because
|
|
||||||
### ynh_add_config keeps track of the file's checksum)
|
|
||||||
|
|
||||||
ynh_add_config --template="some_config_file" --destination="$install_dir/some_config_file"
|
|
||||||
|
|
||||||
# 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/some_config_file"
|
|
||||||
chown $app:$app "$install_dir/some_config_file"
|
|
||||||
|
|
||||||
### 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/some_config_file"
|
|
||||||
### ynh_store_file_checksum --file="$install_dir/some_config_file"
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# START SYSTEMD SERVICE
|
|
||||||
#=================================================
|
|
||||||
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
||||||
|
|
||||||
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# END OF SCRIPT
|
# END OF SCRIPT
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
|
||||||
6
tests.toml
Normal file
6
tests.toml
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json
|
||||||
|
|
||||||
|
test_format = 1.0
|
||||||
|
|
||||||
|
[default]
|
||||||
|
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json
|
|
||||||
|
|
||||||
test_format = 1.0
|
|
||||||
|
|
||||||
[default]
|
|
||||||
|
|
||||||
# ------------
|
|
||||||
# Tests to run
|
|
||||||
# ------------
|
|
||||||
|
|
||||||
# NB: the tests to run are automatically deduced by the CI script according to the
|
|
||||||
# content of the app's manifest. The declarations below allow to customize which
|
|
||||||
# tests are ran, possibly add special test suite to test special args, or
|
|
||||||
# declare which commits to test upgrade from.
|
|
||||||
#
|
|
||||||
# You can also decide (though this is discouraged!) to ban/ignore some tests,
|
|
||||||
|
|
||||||
exclude = ["install.private", "install.multi"] # The test IDs to be used in only/exclude statements are: install.root, install.subdir, install.nourl, install.multi, backup_restore, upgrade, upgrade.someCommitId change_url
|
|
||||||
# NB: you should NOT need this except if you really have a good reason...
|
|
||||||
|
|
||||||
# For special usecases, sometimes you need to setup other things on the machine
|
|
||||||
# prior to installing the app (such as installing another app)
|
|
||||||
# (Remove this key entirely if not needed)
|
|
||||||
preinstall = """
|
|
||||||
sudo yunohost app install foobar
|
|
||||||
sudo yunohost user list
|
|
||||||
"""
|
|
||||||
|
|
||||||
# -------------------------------
|
|
||||||
# Default args to use for install
|
|
||||||
# -------------------------------
|
|
||||||
|
|
||||||
# By default, the CI will automagically fill the 'standard' args
|
|
||||||
# such as domain, path, admin, is_public and password with relevant values
|
|
||||||
# and also install args with a "default" provided in the manifest..
|
|
||||||
# It should only make sense to declare custom args here for args with no default values
|
|
||||||
|
|
||||||
args.language = "fr_FR" # NB: you should NOT need those lines unless for custom questions with no obvious/default value
|
|
||||||
args.multisite = 0
|
|
||||||
|
|
||||||
# -------------------------------
|
|
||||||
# Commits to test upgrade from
|
|
||||||
# -------------------------------
|
|
||||||
|
|
||||||
test_upgrade_from.00a1a6e7.name = "Upgrade from 5.4"
|
|
||||||
test_upgrade_from.00a1a6e7.args.foo = "bar"
|
|
||||||
|
|
||||||
|
|
||||||
# This is an additional test suite
|
|
||||||
[some_additional_testsuite]
|
|
||||||
|
|
||||||
# On additional tests suites, you can decide to run only specific tests
|
|
||||||
|
|
||||||
only = ["install.subdir"]
|
|
||||||
|
|
||||||
args.language = "en_GB"
|
|
||||||
args.multisite = 1
|
|
||||||
Loading…
Add table
Reference in a new issue