From f5b31e078e075ea5d77758c14abd6f8cb35041eb Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 29 May 2022 15:44:59 +0000 Subject: [PATCH 1/7] Auto-update README --- README.md | 22 ++++++++++------------ README_fr.md | 28 +++++++++++++++------------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 764d25c..792832a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Matrix-Telegram bridge for YunoHost -[![Integration level](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![Working status](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg) [![Install Matrix-Telegram bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_telegram) *[Lire ce readme en français.](./README_fr.md)* @@ -51,9 +51,6 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/ **Shipped version:** 0.10.2~ynh3 - - - ## Disclaimers / important information ### Configuration of the bridge @@ -105,22 +102,23 @@ such that it is ensured that synapse is running before the bridge tries to conne ## Documentation and resources -* Official app website: https://docs.mau.fi/bridges/python/telegram/index.html -* Official user documentation: https://docs.mau.fi/bridges/python/telegram/management-commands.html -* Official admin documentation: https://github.com/YunoHost-Apps/mautrix_telegram_ynh -* Upstream app code repository: https://github.com/mautrix/telegram -* YunoHost documentation for this app: https://yunohost.org/app_mautrix_telegram -* Report a bug: https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues +* Official app website: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug or sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 5612b12..85e1fb6 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Matrix-Telegram bridge pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg) [![Installer Matrix-Telegram bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_telegram) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Matrix-Telegram bridge 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.* @@ -47,9 +51,6 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/ **Version incluse :** 0.10.2~ynh3 - - - ## Avertissements / informations importantes ### Configuration of the bridge @@ -101,22 +102,23 @@ such that it is ensured that synapse is running before the bridge tries to conne ## Documentations et ressources -* Site officiel de l'app : https://docs.mau.fi/bridges/python/telegram/index.html -* Documentation officielle utilisateur : https://docs.mau.fi/bridges/python/telegram/management-commands.html -* Documentation officielle de l'admin : https://github.com/YunoHost-Apps/mautrix_telegram_ynh -* Dépôt de code officiel de l'app : https://github.com/mautrix/telegram -* Documentation YunoHost pour cette app : https://yunohost.org/app_mautrix_telegram -* Signaler un bug : https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues +* Site officiel de l'app : +* Documentation officielle utilisateur : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug ou sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** From 9b93bd2e2cdf9a32ac52b579abbff486e4b1eb1d Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 16 Jul 2022 01:38:42 +0200 Subject: [PATCH 2/7] Apply last example_ynh --- .github/ISSUE_TEMPLATE.md | 55 ++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++ check_process | 5 +- conf/nginx.conf | 33 --- conf/php-fpm.conf | 430 ----------------------------- manifest.json | 278 +++++++++---------- scripts/backup | 10 - scripts/install | 82 +++--- scripts/remove | 41 +-- scripts/restore | 49 ++-- scripts/upgrade | 65 ++--- sources/extra_files/app/.gitignore | 2 - sources/patches/.gitignore | 2 - 13 files changed, 317 insertions(+), 751 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 conf/nginx.conf delete mode 100644 conf/php-fpm.conf delete mode 100644 sources/extra_files/app/.gitignore delete mode 100644 sources/patches/.gitignore diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +1. *Read this whole template first.* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + sudo yunohost app install the_app + ``` +- *If you used the webadmin, please perform the equivalent command from the CLI first.* +- *If the error occurs in your browser, explain what you did:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/check_process b/check_process index b77caa5..4f280a9 100644 --- a/check_process +++ b/check_process @@ -11,7 +11,7 @@ botusers="@johndoe:synapsedomain.tld" apiid="1234567" apihash="tjyd5yge35lbodl1jwzw2jstp90k55qz" - bottoken="disabled" + bottoken="disabled" ; Checks pkg_linter=1 setup_sub_dir=0 @@ -25,6 +25,9 @@ multi_instance=1 port_already_use=1 change_url=0 +;;; Options +Email= +Notification=none ;;; Upgrade options ; commit=78e25377746ff6a488614c6ea00b8ce7c7e6d88a name=0.10.1~ynh3 diff --git a/conf/nginx.conf b/conf/nginx.conf deleted file mode 100644 index 37de41d..0000000 --- a/conf/nginx.conf +++ /dev/null @@ -1,33 +0,0 @@ -#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; -location __PATH__/ { - - # Path to source - alias __FINALPATH__/ ; - - # Force usage of https - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - -### Example PHP configuration (remove it if not used) - index index.php; - - # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file - #client_max_body_size 50M; - - try_files $uri $uri/ index.php; - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; - - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } -### End of PHP configuration part - - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; -} diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf deleted file mode 100644 index ab1a471..0000000 --- a/conf/php-fpm.conf +++ /dev/null @@ -1,430 +0,0 @@ -; Start a new pool named 'www'. -; the variable $pool can be used in any directive and will be replaced by the -; pool name ('www' here) -[__NAMETOCHANGE__] - -; Per pool prefix -; It only applies on the following directives: -; - 'access.log' -; - 'slowlog' -; - 'listen' (unixsocket) -; - 'chroot' -; - 'chdir' -; - 'php_values' -; - 'php_admin_values' -; When not set, the global prefix (or /usr) applies instead. -; Note: This directive can also be relative to the global prefix. -; Default Value: none -;prefix = /path/to/pools/$pool - -; Unix user/group of processes -; Note: The user is mandatory. If the group is not set, the default user's group -; will be used. -user = __USER__ -group = __USER__ - -; The address on which to accept FastCGI requests. -; Valid syntaxes are: -; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on -; a specific port; -; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on -; a specific port; -; 'port' - to listen on a TCP socket to all addresses -; (IPv6 and IPv4-mapped) on a specific port; -; '/path/to/unix/socket' - to listen on a unix socket. -; Note: This value is mandatory. -listen = /var/run/php/php__PHPVERSION__-fpm-__NAMETOCHANGE__.sock - -; Set listen(2) backlog. -; Default Value: 511 (-1 on FreeBSD and OpenBSD) -;listen.backlog = 511 - -; Set permissions for unix socket, if one is used. In Linux, read/write -; permissions must be set in order to allow connections from a web server. Many -; BSD-derived systems allow connections regardless of permissions. -; Default Values: user and group are set as the running user -; mode is set to 0660 -listen.owner = www-data -listen.group = www-data -;listen.mode = 0660 -; When POSIX Access Control Lists are supported you can set them using -; these options, value is a comma separated list of user/group names. -; When set, listen.owner and listen.group are ignored -;listen.acl_users = -;listen.acl_groups = - -; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect. -; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original -; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address -; must be separated by a comma. If this value is left blank, connections will be -; accepted from any ip address. -; Default Value: any -;listen.allowed_clients = 127.0.0.1 - -; Specify the nice(2) priority to apply to the pool processes (only if set) -; The value can vary from -19 (highest priority) to 20 (lower priority) -; Note: - It will only work if the FPM master process is launched as root -; - The pool processes will inherit the master process priority -; unless it specified otherwise -; Default Value: no set -; process.priority = -19 - -; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user -; or group is differrent than the master process user. It allows to create process -; core dump and ptrace the process for the pool user. -; Default Value: no -; process.dumpable = yes - -; Choose how the process manager will control the number of child processes. -; Possible Values: -; static - a fixed number (pm.max_children) of child processes; -; dynamic - the number of child processes are set dynamically based on the -; following directives. With this process management, there will be -; always at least 1 children. -; pm.max_children - the maximum number of children that can -; be alive at the same time. -; pm.start_servers - the number of children created on startup. -; pm.min_spare_servers - the minimum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is less than this -; number then some children will be created. -; pm.max_spare_servers - the maximum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is greater than this -; number then some children will be killed. -; ondemand - no children are created at startup. Children will be forked when -; new requests will connect. The following parameter are used: -; pm.max_children - the maximum number of children that -; can be alive at the same time. -; pm.process_idle_timeout - The number of seconds after which -; an idle process will be killed. -; Note: This value is mandatory. -pm = dynamic - -; The number of child processes to be created when pm is set to 'static' and the -; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. -; This value sets the limit on the number of simultaneous requests that will be -; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. -; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP -; CGI. The below defaults are based on a server without much resources. Don't -; forget to tweak pm.* to fit your needs. -; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' -; Note: This value is mandatory. -pm.max_children = 5 - -; The number of child processes created on startup. -; Note: Used only when pm is set to 'dynamic' -; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 -pm.start_servers = 2 - -; The desired minimum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.min_spare_servers = 1 - -; The desired maximum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.max_spare_servers = 3 - -; The number of seconds after which an idle process will be killed. -; Note: Used only when pm is set to 'ondemand' -; Default Value: 10s -;pm.process_idle_timeout = 10s; - -; The number of requests each child process should execute before respawning. -; This can be useful to work around memory leaks in 3rd party libraries. For -; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. -; Default Value: 0 -;pm.max_requests = 500 - -; The URI to view the FPM status page. If this value is not set, no URI will be -; recognized as a status page. It shows the following informations: -; pool - the name of the pool; -; process manager - static, dynamic or ondemand; -; start time - the date and time FPM has started; -; start since - number of seconds since FPM has started; -; accepted conn - the number of request accepted by the pool; -; listen queue - the number of request in the queue of pending -; connections (see backlog in listen(2)); -; max listen queue - the maximum number of requests in the queue -; of pending connections since FPM has started; -; listen queue len - the size of the socket queue of pending connections; -; idle processes - the number of idle processes; -; active processes - the number of active processes; -; total processes - the number of idle + active processes; -; max active processes - the maximum number of active processes since FPM -; has started; -; max children reached - number of times, the process limit has been reached, -; when pm tries to start more children (works only for -; pm 'dynamic' and 'ondemand'); -; Value are updated in real time. -; Example output: -; pool: www -; process manager: static -; start time: 01/Jul/2011:17:53:49 +0200 -; start since: 62636 -; accepted conn: 190460 -; listen queue: 0 -; max listen queue: 1 -; listen queue len: 42 -; idle processes: 4 -; active processes: 11 -; total processes: 15 -; max active processes: 12 -; max children reached: 0 -; -; By default the status page output is formatted as text/plain. Passing either -; 'html', 'xml' or 'json' in the query string will return the corresponding -; output syntax. Example: -; http://www.foo.bar/status -; http://www.foo.bar/status?json -; http://www.foo.bar/status?html -; http://www.foo.bar/status?xml -; -; By default the status page only outputs short status. Passing 'full' in the -; query string will also return status for each pool process. -; Example: -; http://www.foo.bar/status?full -; http://www.foo.bar/status?json&full -; http://www.foo.bar/status?html&full -; http://www.foo.bar/status?xml&full -; The Full status returns for each process: -; pid - the PID of the process; -; state - the state of the process (Idle, Running, ...); -; start time - the date and time the process has started; -; start since - the number of seconds since the process has started; -; requests - the number of requests the process has served; -; request duration - the duration in µs of the requests; -; request method - the request method (GET, POST, ...); -; request URI - the request URI with the query string; -; content length - the content length of the request (only with POST); -; user - the user (PHP_AUTH_USER) (or '-' if not set); -; script - the main script called (or '-' if not set); -; last request cpu - the %cpu the last request consumed -; it's always 0 if the process is not in Idle state -; because CPU calculation is done when the request -; processing has terminated; -; last request memory - the max amount of memory the last request consumed -; it's always 0 if the process is not in Idle state -; because memory calculation is done when the request -; processing has terminated; -; If the process is in Idle state, then informations are related to the -; last request the process has served. Otherwise informations are related to -; the current request being served. -; Example output: -; ************************ -; pid: 31330 -; state: Running -; start time: 01/Jul/2011:17:53:49 +0200 -; start since: 63087 -; requests: 12808 -; request duration: 1250261 -; request method: GET -; request URI: /test_mem.php?N=10000 -; content length: 0 -; user: - -; script: /home/fat/web/docs/php/test_mem.php -; last request cpu: 0.00 -; last request memory: 0 -; -; Note: There is a real-time FPM status monitoring sample web page available -; It's available in: /usr/share/php/7.0/fpm/status.html -; -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -;pm.status_path = /status - -; The ping URI to call the monitoring page of FPM. If this value is not set, no -; URI will be recognized as a ping page. This could be used to test from outside -; that FPM is alive and responding, or to -; - create a graph of FPM availability (rrd or such); -; - remove a server from a group if it is not responding (load balancing); -; - trigger alerts for the operating team (24/7). -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -;ping.path = /ping - -; This directive may be used to customize the response of a ping request. The -; response is formatted as text/plain with a 200 response code. -; Default Value: pong -;ping.response = pong - -; The access log file -; Default: not set -;access.log = log/$pool.access.log - -; The access log format. -; The following syntax is allowed -; %%: the '%' character -; %C: %CPU used by the request -; it can accept the following format: -; - %{user}C for user CPU only -; - %{system}C for system CPU only -; - %{total}C for user + system CPU (default) -; %d: time taken to serve the request -; it can accept the following format: -; - %{seconds}d (default) -; - %{miliseconds}d -; - %{mili}d -; - %{microseconds}d -; - %{micro}d -; %e: an environment variable (same as $_ENV or $_SERVER) -; it must be associated with embraces to specify the name of the env -; variable. Some exemples: -; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e -; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e -; %f: script filename -; %l: content-length of the request (for POST request only) -; %m: request method -; %M: peak of memory allocated by PHP -; it can accept the following format: -; - %{bytes}M (default) -; - %{kilobytes}M -; - %{kilo}M -; - %{megabytes}M -; - %{mega}M -; %n: pool name -; %o: output header -; it must be associated with embraces to specify the name of the header: -; - %{Content-Type}o -; - %{X-Powered-By}o -; - %{Transfert-Encoding}o -; - .... -; %p: PID of the child that serviced the request -; %P: PID of the parent of the child that serviced the request -; %q: the query string -; %Q: the '?' character if query string exists -; %r: the request URI (without the query string, see %q and %Q) -; %R: remote IP address -; %s: status (response code) -; %t: server time the request was received -; it can accept a strftime(3) format: -; %d/%b/%Y:%H:%M:%S %z (default) -; The strftime(3) format must be encapsuled in a %{}t tag -; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t -; %T: time the log has been written (the request has finished) -; it can accept a strftime(3) format: -; %d/%b/%Y:%H:%M:%S %z (default) -; The strftime(3) format must be encapsuled in a %{}t tag -; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t -; %u: remote user -; -; Default: "%R - %u %t \"%m %r\" %s" -;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" - -; The log file for slow requests -; Default Value: not set -; Note: slowlog is mandatory if request_slowlog_timeout is set -;slowlog = log/$pool.log.slow - -; The timeout for serving a single request after which a PHP backtrace will be -; dumped to the 'slowlog' file. A value of '0s' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -;request_slowlog_timeout = 0 - -; The timeout for serving a single request after which the worker process will -; be killed. This option should be used when the 'max_execution_time' ini option -; does not stop script execution for some reason. A value of '0' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -request_terminate_timeout = 1d - -; Set open file descriptor rlimit. -; Default Value: system defined value -;rlimit_files = 1024 - -; Set max core size rlimit. -; Possible Values: 'unlimited' or an integer greater or equal to 0 -; Default Value: system defined value -;rlimit_core = 0 - -; Chroot to this directory at the start. This value must be defined as an -; absolute path. When this value is not set, chroot is not used. -; Note: you can prefix with '$prefix' to chroot to the pool prefix or one -; of its subdirectories. If the pool prefix is not set, the global prefix -; will be used instead. -; Note: chrooting is a great security feature and should be used whenever -; possible. However, all PHP paths will be relative to the chroot -; (error_log, sessions.save_path, ...). -; Default Value: not set -;chroot = - -; Chdir to this directory at the start. -; Note: relative path can be used. -; Default Value: current directory or / when chroot -chdir = __FINALPATH__ - -; Redirect worker stdout and stderr into main error log. If not set, stdout and -; stderr will be redirected to /dev/null according to FastCGI specs. -; Note: on highloaded environement, this can cause some delay in the page -; process time (several ms). -; Default Value: no -;catch_workers_output = yes - -; Clear environment in FPM workers -; Prevents arbitrary environment variables from reaching FPM worker processes -; by clearing the environment in workers before env vars specified in this -; pool configuration are added. -; Setting to "no" will make all environment variables available to PHP code -; via getenv(), $_ENV and $_SERVER. -; Default Value: yes -;clear_env = no - -; Limits the extensions of the main script FPM will allow to parse. This can -; prevent configuration mistakes on the web server side. You should only limit -; FPM to .php extensions to prevent malicious users to use other extensions to -; execute php code. -; Note: set an empty value to allow all extensions. -; Default Value: .php -;security.limit_extensions = .php .php3 .php4 .php5 .php7 - -; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from -; the current environment. -; Default Value: clean env -;env[HOSTNAME] = $HOSTNAME -;env[PATH] = /usr/local/bin:/usr/bin:/bin -;env[TMP] = /tmp -;env[TMPDIR] = /tmp -;env[TEMP] = /tmp - -; Additional php.ini defines, specific to this pool of workers. These settings -; overwrite the values previously defined in the php.ini. The directives are the -; same as the PHP SAPI: -; php_value/php_flag - you can set classic ini defines which can -; be overwritten from PHP call 'ini_set'. -; php_admin_value/php_admin_flag - these directives won't be overwritten by -; PHP call 'ini_set' -; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. - -; Defining 'extension' will load the corresponding shared extension from -; extension_dir. Defining 'disable_functions' or 'disable_classes' will not -; overwrite previously defined php.ini values, but will append the new value -; instead. - -; Note: path INI options can be relative and will be expanded with the prefix -; (pool, global or /usr) - -; Default Value: nothing is defined by default except the values in php.ini and -; specified at startup with the -d argument -;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com -;php_flag[display_errors] = off -;php_admin_value[error_log] = /var/log/fpm-php.www.log -;php_admin_flag[log_errors] = on -;php_admin_value[memory_limit] = 32M - -; Common values to change to increase file upload limit -; php_admin_value[upload_max_filesize] = 50M -; php_admin_value[post_max_size] = 50M -; php_admin_flag[mail.add_x_header] = Off - -; Other common parameters -; php_admin_value[max_execution_time] = 600 -; php_admin_value[max_input_time] = 300 -; php_admin_value[memory_limit] = 256M -; php_admin_flag[short_open_tag] = On diff --git a/manifest.json b/manifest.json index 2df5204..ce097d5 100644 --- a/manifest.json +++ b/manifest.json @@ -1,146 +1,144 @@ { - "name": "Matrix-Telegram bridge", - "id": "mautrix_telegram", - "packaging_format": 1, - "description": { - "en": "Telegram puppeting bridge for Matrix/Synapse", - "fr": "Passerelle Telegram pour Matrix/Synapse" - }, - "version": "0.10.2~ynh3", - "url": "https://docs.mau.fi/bridges/python/telegram/index.html", - "upstream": { - "license": "free", + "name": "Matrix-Telegram bridge", + "id": "mautrix_telegram", + "packaging_format": 1, + "description": { + "en": "Telegram puppeting bridge for Matrix/Synapse", + "fr": "Passerelle Telegram pour Matrix/Synapse" + }, + "version": "0.10.2~ynh4", + "url": "https://docs.mau.fi/bridges/python/telegram/index.html", + "upstream": { + "license": "AGPL-3.0-or-later", "website": "https://docs.mau.fi/bridges/python/telegram/index.html", "admindoc": "https://github.com/YunoHost-Apps/mautrix_telegram_ynh", "userdoc": "https://docs.mau.fi/bridges/python/telegram/management-commands.html", "code": "https://github.com/mautrix/telegram" - }, - "license": "AGPL-3.0-or-later", - "maintainer": { - "name": "", - "email": "", - "url": "https://github.com/YunoHost-Apps/mautrix_telegram_ynh" - }, - "requirements": { - "yunohost": ">= 4.2.4" - }, - "multi_instance": true, - "services": [ - "postgresql" - ], - "arguments": { - "install": [ - { - "name": "synapsenumber", - "type": "string", - "ask": { - "en": "Choose the local synapse instance number to communicate with mautrix_telegram", - "fr": "Choisissez le numéro de l'instance synapse qui doit communiquer avec mautrix_telegram" - }, - "example": "2 (for instance synapse__2)", - "help": { - "en": "If you installed synapse only once time, then leave default value 1.", - "fr": "Si vous n'avez installé qu'une fois synapse, gardez la valeur par défaut 1." - }, - "default": "1" - }, - { - "name": "botname", - "type": "string", - "ask": { - "en": "Choose a local synapse user name for the Telegram bot", - "fr": "Choisissez un nom d'utilisateur synapse local pour le robot Telegram" - }, - "example": "telegrambot", - "help": { - "en": "A system user will be created. Invite @telegrambot:localsynapse.servername from an authorized Matrix account to start bridging. Give the matrix server_name, not the full domain/url.", - "fr": "Un utilisateur système sera créé. Inviter @telegrambot:localsynapse.servername depuis un compte Matrix autorisé pour démarrer une passerelle. Donner le nom du serveur matrix, pas le domaine/url complet." - }, - "default": "telegrambot" - }, - { - "name": "encryption", - "type": "boolean", - "ask": { - "en": "Enable end-to-bridge encryption?", - "fr": "Activer le chiffrement entre Synapse et le bridge ?" - }, - "help": { - "en": "Only activate if you know the prerequisites and constraints related to e2b.", - "fr": "N'activer que si vous connaissez les prérequis et constraintes liées à e2b." - }, - "default": false - }, - { - "name": "botadmin", - "type": "string", - "ask": { - "en": "Choose the Matrix account administrator of the Telegram bot; admin permission", - "fr": "Choisissez le compte Matrix administrateur du robot Telegram" - }, - "example": "@johndoe:localsynapse.servername or @johndoe:matrix.org", - "help": { - "en": "The Telegram bot administrator does not need to be a local synapse account.", - "fr": "Le compte administrateur du robot Telegram peut ne pas être un compte local synapse." - }, - "default": "" - }, - { - "name": "botusers", - "type": "string", - "ask": { - "en": "Choose Matrix user(s) authorized to bridge with the Telegram bot; puppeting permission", - "fr": "Choisissez le/les compte(s) Matrix autorisés à utiliser le robot Telegram" - }, - "example": "local or @johndoe:server.name or server.name or *", - "default": "local", - "help": { - "en": "All local synapse users (local), a remote or local user (@johndoe:server.name), a remote server (matrix.org), or all remote/local servers (*) can be authorized. Give the matrix server_name, not the full domain/url.", - "fr": "On peut autoriser tous les comptes synapse locaux (local), un compte local ou distant (@johndoe:server.name), un serveur distant (matrix.org), ou tous les serveurs remote/local (*). Donner le nom du serveur matrix, pas le domaine/url complet." - } - }, - { - "name": "apiid", - "type": "string", - "ask": { - "en": "Telegram API keys (https://my.telegram.org/apps): ID", - "fr": "TODO" - }, - "example": "1234567", - "default": "", - "help": { - "en": "Get your own API keys at https://my.telegram.org/apps", - "fr": "Obtenez vos propres clés API sur https://my.telegram.org/apps" - } - }, - { - "name": "apihash", - "type": "string", - "ask": { - "en": "Telegram API keys (https://my.telegram.org/apps): Hash", - "fr": "Clés API Telegram (https://my.telegram.org/apps) : Hash" - }, - "example": "tjyd5yge35lbodk1xwzw2jstp90k55qz", - "default": "", - "help": { - "en": "Get your own API keys at https://my.telegram.org/apps", - "fr": "TODO" - } - }, - { - "name": "bottoken", - "type": "string", - "ask": { - "en": "Telegram bot token (optional)", - "fr": "Jeton de bot de Telegram (facultatif) " - }, - "example": "disabled", - "default": "disabled", - "help": { - "en": "Create your own telegram bot.", - "fr": "Créez votre propre bot de Telegram." - } - } - ] - } + }, + "license": "AGPL-3.0-or-later", + "maintainer": { + "name": "", + "email": "" + }, + "requirements": { + "yunohost": ">= 4.3.0" + }, + "multi_instance": true, + "services": [ + ], + "arguments": { + "install": [ + { + "name": "synapsenumber", + "type": "string", + "ask": { + "en": "Choose the local synapse instance number to communicate with mautrix_telegram", + "fr": "Choisissez le numéro de l'instance synapse qui doit communiquer avec mautrix_telegram" + }, + "example": "2 (for instance synapse__2)", + "help": { + "en": "If you installed synapse only once time, then leave default value 1.", + "fr": "Si vous n'avez installé qu'une fois synapse, gardez la valeur par défaut 1." + }, + "default": "1" + }, + { + "name": "botname", + "type": "string", + "ask": { + "en": "Choose a local synapse user name for the Telegram bot", + "fr": "Choisissez un nom d'utilisateur synapse local pour le robot Telegram" + }, + "example": "telegrambot", + "help": { + "en": "A system user will be created. Invite @telegrambot:localsynapse.servername from an authorized Matrix account to start bridging. Give the matrix server_name, not the full domain/url.", + "fr": "Un utilisateur système sera créé. Inviter @telegrambot:localsynapse.servername depuis un compte Matrix autorisé pour démarrer une passerelle. Donner le nom du serveur matrix, pas le domaine/url complet." + }, + "default": "telegrambot" + }, + { + "name": "encryption", + "type": "boolean", + "ask": { + "en": "Enable end-to-bridge encryption?", + "fr": "Activer le chiffrement entre Synapse et le bridge ?" + }, + "help": { + "en": "Only activate if you know the prerequisites and constraints related to e2b.", + "fr": "N'activer que si vous connaissez les prérequis et constraintes liées à e2b." + }, + "default": false + }, + { + "name": "botadmin", + "type": "string", + "ask": { + "en": "Choose the Matrix account administrator of the Telegram bot; admin permission", + "fr": "Choisissez le compte Matrix administrateur du robot Telegram" + }, + "example": "@johndoe:localsynapse.servername or @johndoe:matrix.org", + "help": { + "en": "The Telegram bot administrator does not need to be a local synapse account.", + "fr": "Le compte administrateur du robot Telegram peut ne pas être un compte local synapse." + }, + "default": "" + }, + { + "name": "botusers", + "type": "string", + "ask": { + "en": "Choose Matrix user(s) authorized to bridge with the Telegram bot; puppeting permission", + "fr": "Choisissez le/les compte(s) Matrix autorisés à utiliser le robot Telegram" + }, + "example": "local or @johndoe:server.name or server.name or *", + "default": "local", + "help": { + "en": "All local synapse users (local), a remote or local user (@johndoe:server.name), a remote server (matrix.org), or all remote/local servers (*) can be authorized. Give the matrix server_name, not the full domain/url.", + "fr": "On peut autoriser tous les comptes synapse locaux (local), un compte local ou distant (@johndoe:server.name), un serveur distant (matrix.org), ou tous les serveurs remote/local (*). Donner le nom du serveur matrix, pas le domaine/url complet." + } + }, + { + "name": "apiid", + "type": "string", + "ask": { + "en": "Telegram API keys (https://my.telegram.org/apps): ID", + "fr": "TODO" + }, + "example": "1234567", + "default": "", + "help": { + "en": "Get your own API keys at https://my.telegram.org/apps", + "fr": "Obtenez vos propres clés API sur https://my.telegram.org/apps" + } + }, + { + "name": "apihash", + "type": "string", + "ask": { + "en": "Telegram API keys (https://my.telegram.org/apps): Hash", + "fr": "Clés API Telegram (https://my.telegram.org/apps) : Hash" + }, + "example": "tjyd5yge35lbodk1xwzw2jstp90k55qz", + "default": "", + "help": { + "en": "Get your own API keys at https://my.telegram.org/apps", + "fr": "TODO" + } + }, + { + "name": "bottoken", + "type": "string", + "ask": { + "en": "Telegram bot token (optional)", + "fr": "Jeton de bot de Telegram (facultatif) " + }, + "example": "disabled", + "default": "disabled", + "help": { + "en": "Create your own telegram bot.", + "fr": "Créez votre propre bot de Telegram." + } + } + ] + } } diff --git a/scripts/backup b/scripts/backup index 624e5ca..38be0ba 100755 --- a/scripts/backup +++ b/scripts/backup @@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script @@ -36,16 +35,10 @@ mautrix_bridge_db_name=$(ynh_app_setting_get --app=$app --key=mautrix_bridge_db_ #================================================= 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 #================================================= -# includes config file ynh_backup --src_path="$final_path" #================================================= @@ -74,9 +67,6 @@ ynh_backup --src_path="$app_service_registration_path" #================================================= ynh_print_info --message="Backing up the PostgreSQL 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_psql_dump_db --database="$mautrix_bridge_db_name" > db.sql #================================================= diff --git a/scripts/install b/scripts/install index 7af3af8..9d6ac83 100755 --- a/scripts/install +++ b/scripts/install @@ -14,8 +14,7 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. - true + ynh_clean_check_starting } # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -36,7 +35,6 @@ apihash=$YNH_APP_ARG_APIHASH bottoken=$YNH_APP_ARG_BOTTOKEN app=$YNH_APP_INSTANCE_NAME -final_path=/opt/yunohost/$app # TODO check (in manifest?) if the selected synapse instance is not already connected to a mautrix_bridge bridge if [ $synapsenumber -eq "1" ] @@ -69,25 +67,15 @@ upstream_version=$(ynh_app_upstream_version) #================================================= ynh_script_progression --message="Validating installation parameters..." --weight=1 +final_path=/opt/yunohost/$app test ! -e "$final_path" || ynh_die --message="This path already contains a folder" -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -ynh_script_progression --message="Finding an available port..." --weight=1 - -# Find a free port for communication between your local synapse instance (home server) and its app service mautrix_bridge. -port=$(ynh_find_port --port=29317) - #================================================= # STORE SETTINGS FROM MANIFEST #================================================= ynh_script_progression --message="Storing installation settings..." --weight=7 ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=server_name --value=$server_name -ynh_app_setting_set --app=$app --key=port --value=$port ynh_app_setting_set --app=$app --key=botname --value=$botname ynh_app_setting_set --app=$app --key=synapse_instance --value=$synapse_instance ynh_app_setting_set --app=$app --key=app_service_registration_path --value=$app_service_registration_path @@ -103,6 +91,17 @@ ynh_app_setting_set --app=$app --key=bottoken --value=$bottoken ynh_app_setting_set --app=$app --key=mautrix_version --value=$upstream_version ynh_app_setting_set --app=$app --key=final_path --value=$final_path +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# FIND AND OPEN A PORT +#================================================= +ynh_script_progression --message="Finding an available port..." --weight=1 + +# Find a free port for communication between your local synapse instance (home server) and its app service mautrix_bridge. +port=$(ynh_find_port --port=29317) +ynh_app_setting_set --app=$app --key=port --value=$port + #================================================= # INSTALL DEPENDENCIES #================================================= @@ -110,6 +109,14 @@ ynh_script_progression --message="Installing dependencies..." --weight=97 ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Configuring system user..." --weight=1 + +# Create a system user +ynh_system_user_create --username=$mautrix_bridge_user + #================================================= # CREATE A POSTGRESQL DATABASE #================================================= @@ -133,10 +140,6 @@ ynh_psql_execute_as_root \ #================================================= ynh_script_progression --message="Setting up source files..." --weight=3 -### `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 - ynh_app_setting_set --app=$app --key=final_path --value=$final_path # WARNING : theses command are used in INSTALL, UPGRADE (2 times) @@ -150,24 +153,7 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path ynh_setup_source --dest_dir="$final_path/src" #================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$mautrix_bridge_user - -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=20 - -# Create systemd config for Mautrix-Bridge -#cp ../conf/default_mautrix-facebook /etc/default/$app -ynh_add_systemd_config --service=$app - -#================================================= - +# SPECIFIC SETUP #================================================= # SET MAUTRIX-BRIDGE CONFIG #================================================= @@ -208,29 +194,29 @@ $final_path/bin/alembic -c "$final_path/alembic.ini" -x config="$mautrix_config # STORE THE CONFIG FILE CHECKSUM #================================================= -### `ynh_store_file_checksum` is used to store the checksum of a file. -### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`, -### you can make a backup of this file before modifying it again if the admin had modified it. - # Calculate and store the config file checksum into the app settings ynh_store_file_checksum --file="$mautrix_config_path" ynh_store_file_checksum --file="$app_service_registration_path/$app.yaml" ynh_store_file_checksum --file="$final_path/alembic.ini" #================================================= -# GENERIC FINALIZATION +# SETUP SYSTEMD +#================================================= +ynh_script_progression --message="Configuring a systemd service..." --weight=20 + +# Create a dedicated systemd config +ynh_add_systemd_config + #================================================= # SECURE FILES AND DIRECTORIES #================================================= -### For security reason, any app should set the permissions to root: before anything else. -### Then, if write authorization is needed, any access should be given only to directories -### that really need such authorization. - # WARNING : theses command are used in INSTALL, UPGRADE, RESTORE # For any update do it in all files chown $mautrix_bridge_user:root -R $final_path +#================================================= +# GENERIC FINALIZATION #================================================= # SETUP LOGROTATE #================================================= @@ -242,10 +228,10 @@ ynh_use_logrotate --logfile "/var/log/$app/$app.log" --specific_user $mautrix_br chown $mautrix_bridge_user:root -R /var/log/$app #================================================= -# ADVERTISE SERVICE IN ADMIN PANEL +# INTEGRATE SERVICE IN YUNOHOST #================================================= -#yunohost service add $app --log "/var/log/$app/log.log" -# if using yunohost version 3.2 or more in the 'manifest.json', a description can be added +ynh_script_progression --message="Integrating service in YunoHost..." + yunohost service add $app --description "$app daemon for bridging Telegram and Matrix messages" --log "/var/log/$app/$app.log" #================================================= diff --git a/scripts/remove b/scripts/remove index 0888f0e..e7c2616 100755 --- a/scripts/remove +++ b/scripts/remove @@ -36,13 +36,13 @@ mautrix_bridge_db_user=$app #================================================= # STANDARD REMOVE #================================================= -# REMOVE SERVICE FROM ADMIN PANEL +# REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= -# Remove a service from the admin panel, added by `yunohost service add` +# 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..." --weight=3 + ynh_script_progression --message="Removing $app service integration..." --weight=3 yunohost service remove $app fi @@ -54,6 +54,14 @@ ynh_script_progression --message="Stopping and removing the systemd service..." # Remove the dedicated systemd config ynh_remove_systemd_config +#================================================= +# REMOVE LOGROTATE CONFIGURATION +#================================================= +ynh_script_progression --message="Removing logrotate configuration..." --weight=1 + +# Remove the app-specific logrotate config +ynh_remove_logrotate + #================================================= # REMOVE THE POSTGRESQL DATABASE #================================================= @@ -65,6 +73,14 @@ ynh_psql_execute_as_root --database=$synapse_db_name --sql="DROP OWNED BY ""$bot ynh_psql_execute_as_root --database=$synapse_db_name --sql="DROP USER ""$botname"";" #yunohost app action run $synapse_instance drop_user -a username=$botname +#================================================= +# REMOVE APP MAIN DIR +#================================================= +ynh_script_progression --message="Removing app main directory..." --weight=1 + +# Remove the app directory securely +ynh_secure_remove --file="$final_path" + #================================================= # REMOVE DEPENDENCIES #================================================= @@ -73,26 +89,11 @@ ynh_script_progression --message="Removing dependencies..." --weight=8 # Remove metapackage and its dependencies ynh_remove_app_dependencies -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -#ynh_secure_remove --file="/etc/$app/" -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Removing logrotate configuration..." --weight=1 - -# Remove the app-specific logrotate config -ynh_remove_logrotate - #================================================= # SPECIFIC REMOVE #================================================= +# REMOVE VARIOUS FILES +#================================================= ynh_script_progression --message="Removing synapse app service..." --weight=6 # Remove a directory securely diff --git a/scripts/restore b/scripts/restore index 3bc036a..9476169 100755 --- a/scripts/restore +++ b/scripts/restore @@ -15,8 +15,7 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. - true + ynh_clean_check_starting } # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -29,7 +28,6 @@ ynh_script_progression --message="Loading installation settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME mautrix_bridge_user=$app - domain=$(ynh_app_setting_get --app=$app --key=domain) final_path=$(ynh_app_setting_get --app=$app --key=final_path) mautrix_bridge_db_name=$(ynh_app_setting_get --app=$app --key=mautrix_bridge_db_name) @@ -48,13 +46,6 @@ test ! -d $final_path \ #================================================= # STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE APP MAIN DIR -#================================================= -ynh_script_progression --message="Restoring the app main directory..." --weight=1 - -ynh_restore_file --origin_path="$final_path" - #================================================= # RECREATE THE DEDICATED USER #================================================= @@ -64,10 +55,12 @@ ynh_script_progression --message="Recreating the dedicated system user..." --wei ynh_system_user_create --username=$app #================================================= -# RESTORE USER RIGHTS +# RESTORE THE APP MAIN DIR #================================================= +ynh_script_progression --message="Restoring the app main directory..." --weight=1 + +ynh_restore_file --origin_path="$final_path" -# Restore permissions on app files chown $mautrix_bridge_user:root -R $final_path #================================================= @@ -80,20 +73,25 @@ ynh_script_progression --message="Reinstalling dependencies..." --weight=1 # Define and install dependencies ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies -# TODO #================================================= # RESTORE THE MYSQL DATABASE #================================================= -# ynh_script_progression --message="Restoring the MySQL database..." --weight=1 +ynh_script_progression --message="Restoring the MySQL database..." --weight=1 ynh_psql_test_if_first_run ynh_print_OFF ynh_psql_create_user $mautrix_bridge_db_user $mautrix_bridge_db_pwd ynh_print_ON -ynh_psql_execute_as_root \ ---sql="CREATE DATABASE ""$mautrix_bridge_db_name"" ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER ""$mautrix_bridge_db_user"";" +ynh_psql_execute_as_root --sql="CREATE DATABASE ""$mautrix_bridge_db_name"" ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER ""$mautrix_bridge_db_user"";" ynh_psql_execute_file_as_root --file="db.sql" --database="$mautrix_bridge_db_name" +#================================================= +# RESTORE VARIOUS FILES +#================================================= +ynh_script_progression --message="Restoring various files..." + +ynh_restore_file --origin_path="$app_service_registration_path" + #================================================= # RESTORE SYSTEMD #================================================= @@ -102,6 +100,13 @@ ynh_script_progression --message="Restoring the systemd configuration..." --weig ynh_restore_file --origin_path="/etc/systemd/system/$app.service" systemctl enable $app.service --quiet +#================================================= +# RESTORE THE LOGROTATE CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the logrotate configuration..." + +ynh_restore_file --origin_path="/etc/logrotate.d/$app" + #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= @@ -116,18 +121,6 @@ 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" -#================================================= -# RESTORE THE LOGROTATE CONFIGURATION -#================================================= - -ynh_restore_file --origin_path="/etc/logrotate.d/$app" - -#================================================= -# RESTORE VARIOUS FILES -#================================================= - -ynh_restore_file --origin_path="$app_service_registration_path" - #================================================= # GENERIC FINALIZATION #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 896060e..cb11539 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -39,26 +39,10 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= # CHECK VERSION #================================================= +ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# 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 final_path doesn't exist, create it -#if [ -z "$final_path" ]; then -# final_path=/var/www/$app -# ynh_app_setting_set --app=$app --key=final_path --value=$final_path -#fi - #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= @@ -67,6 +51,7 @@ ynh_script_progression --message="Backing up the app before upgrading (may take # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { + ynh_clean_check_starting # Restore it if the upgrade fails ynh_restore_upgradebackup } @@ -82,6 +67,19 @@ 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" +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 + +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 + +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$mautrix_bridge_user + #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -101,18 +99,10 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=1 ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$mautrix_bridge_user - #================================================= # SPECIFIC UPGRADE #================================================= -# ... +# UPGRADE PYTHON PACKAGE #================================================= if [ "$upgrade_type" == "UPGRADE_APP" ]; then @@ -124,16 +114,9 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]; then fi #================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 - -# Create a dedicated systemd config -ynh_add_systemd_config - -#================================================= -# UPDATE/MODIFY THE CONFIG FILE +# UPDATE A CONFIG FILE #================================================= +ynh_script_progression --message="Updating a configuration file..." # main configuration mautrix_config_path="$final_path/config.yaml" @@ -163,7 +146,13 @@ ynh_store_file_checksum --file="$app_service_registration_path/$app.yaml" ynh_store_file_checksum --file="$final_path/alembic.ini" #================================================= -# GENERIC FINALIZATION +# SETUP SYSTEMD +#================================================= +ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 + +# Create a dedicated systemd config +ynh_add_systemd_config + #================================================= # SECURE FILES AND DIRECTORIES #================================================= @@ -171,6 +160,8 @@ ynh_store_file_checksum --file="$final_path/alembic.ini" # Set permissions on app files chown $mautrix_bridge_user:root -R $final_path +#================================================= +# GENERIC FINALIZATION #================================================= # SETUP LOGROTATE #================================================= @@ -194,7 +185,7 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" #================================================= -# RELOAD synapse +# RELOAD SYNAPSE #================================================= ynh_script_progression --message="Reloading synapse server..." --weight=1 diff --git a/sources/extra_files/app/.gitignore b/sources/extra_files/app/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/extra_files/app/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] diff --git a/sources/patches/.gitignore b/sources/patches/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/patches/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] From fed24db6c0f05716473e8c25a88564b55c710c9f Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 15 Jul 2022 23:38:47 +0000 Subject: [PATCH 3/7] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 792832a..b40292b 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/ * see https://docs.mau.fi/bridges/python/telegram/relay-bot.html -**Shipped version:** 0.10.2~ynh3 +**Shipped version:** 0.10.2~ynh4 ## Disclaimers / important information ### Configuration of the bridge diff --git a/README_fr.md b/README_fr.md index 85e1fb6..f0a3111 100644 --- a/README_fr.md +++ b/README_fr.md @@ -50,7 +50,7 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/ * see https://docs.mau.fi/bridges/python/telegram/relay-bot.html -**Version incluse :** 0.10.2~ynh3 +**Version incluse :** 0.10.2~ynh4 ## Avertissements / informations importantes ### Configuration of the bridge From b71fd137e26f943d64563bcb49325e52bfa69926 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 16 Jul 2022 16:19:17 +0200 Subject: [PATCH 4/7] Cleanup --- doc/DISCLAIMER.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 994c91f..a4363a9 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -28,12 +28,6 @@ In case you need to upload your logs somewhere, be aware that they contain your * Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Telegram accounts. * Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances. -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_telegram/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_telegram/) - - ### Troubleshooting * Check the spelling of the bot name! From fc55851fc168227fc35f860a367e1058a901f838 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 16 Jul 2022 14:19:22 +0000 Subject: [PATCH 5/7] Auto-update README --- README.md | 6 ------ README_fr.md | 6 ------ 2 files changed, 12 deletions(-) diff --git a/README.md b/README.md index b40292b..4173e86 100644 --- a/README.md +++ b/README.md @@ -83,12 +83,6 @@ In case you need to upload your logs somewhere, be aware that they contain your * Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Telegram accounts. * Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances. -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_telegram/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_telegram/) - - ### Troubleshooting * Check the spelling of the bot name! diff --git a/README_fr.md b/README_fr.md index f0a3111..56d7d09 100644 --- a/README_fr.md +++ b/README_fr.md @@ -83,12 +83,6 @@ In case you need to upload your logs somewhere, be aware that they contain your * Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Telegram accounts. * Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances. -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_telegram/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_telegram/) - - ### Troubleshooting * Check the spelling of the bot name! From 0fd0bb3892bdd5d5166496c74f3aa05268ceca95 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 16 Jul 2022 16:20:47 +0200 Subject: [PATCH 6/7] Remove ynh_print_ON/OFF --- scripts/install | 7 +------ scripts/restore | 2 -- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/scripts/install b/scripts/install index 9d6ac83..2ffc5a6 100755 --- a/scripts/install +++ b/scripts/install @@ -122,18 +122,13 @@ ynh_system_user_create --username=$mautrix_bridge_user #================================================= ynh_script_progression --message="Creating a PostgreSQL database..." --weight=3 -ynh_print_OFF mautrix_bridge_db_pwd=$(ynh_string_random --length=30) ynh_app_setting_set --app=$app --key=mautrix_bridge_db_pwd --value=$mautrix_bridge_db_pwd -ynh_print_ON # Create postgresql database ynh_psql_test_if_first_run -ynh_print_OFF ynh_psql_create_user $mautrix_bridge_db_user $mautrix_bridge_db_pwd -ynh_print_ON -ynh_psql_execute_as_root \ ---sql="CREATE DATABASE ""$mautrix_bridge_db_name"" ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER ""$mautrix_bridge_db_user"";" +ynh_psql_execute_as_root --sql="CREATE DATABASE ""$mautrix_bridge_db_name"" ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER ""$mautrix_bridge_db_user"";" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE diff --git a/scripts/restore b/scripts/restore index 9476169..e7212ea 100755 --- a/scripts/restore +++ b/scripts/restore @@ -79,9 +79,7 @@ ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies ynh_script_progression --message="Restoring the MySQL database..." --weight=1 ynh_psql_test_if_first_run -ynh_print_OFF ynh_psql_create_user $mautrix_bridge_db_user $mautrix_bridge_db_pwd -ynh_print_ON ynh_psql_execute_as_root --sql="CREATE DATABASE ""$mautrix_bridge_db_name"" ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER ""$mautrix_bridge_db_user"";" ynh_psql_execute_file_as_root --file="db.sql" --database="$mautrix_bridge_db_name" From 4a4004ade2ec4809a354adec7d1b11cf6aa77e96 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 16 Jul 2022 16:24:51 +0200 Subject: [PATCH 7/7] less warnings --- scripts/install | 9 +++------ scripts/remove | 2 +- scripts/upgrade | 8 +++----- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/scripts/install b/scripts/install index 2ffc5a6..2880324 100755 --- a/scripts/install +++ b/scripts/install @@ -176,14 +176,11 @@ $final_path/bin/python3 -m mautrix_telegram -g -c "$mautrix_config_path" -r "$ap # initialize the database # HACK alembic won't find its script dir using a relative path unless when started from $final_path # therefore we replace the script_location -ynh_replace_string --match_string="script_location = alembic" \ - --replace_string="script_location = $final_path/alembic" \ - --target_file="$final_path/alembic.ini" -$final_path/bin/alembic -c "$final_path/alembic.ini" -x config="$mautrix_config_path" upgrade head +ynh_replace_string --match_string="script_location = alembic" --replace_string="script_location = $final_path/alembic" --target_file="$final_path/alembic.ini" +ynh_exec_warn_less $final_path/bin/alembic -c "$final_path/alembic.ini" -x config="$mautrix_config_path" upgrade head # Handled by synapse: synapse_ynh adds all registration files added in $app_service_registration_path to the app_service_config_files list -/opt/yunohost/matrix-$synapse_instance/update_synapse_for_appservice.sh \ - || ynh_die "Synapse can't restart with the appservice configuration" +/opt/yunohost/matrix-$synapse_instance/update_synapse_for_appservice.sh || ynh_die --message="Synapse can't restart with the appservice configuration" #================================================= # STORE THE CONFIG FILE CHECKSUM diff --git a/scripts/remove b/scripts/remove index e7c2616..9382730 100755 --- a/scripts/remove +++ b/scripts/remove @@ -100,7 +100,7 @@ ynh_script_progression --message="Removing synapse app service..." --weight=6 ynh_secure_remove --file="$app_service_registration_path/$app.yaml" /opt/yunohost/matrix-$synapse_instance/update_synapse_for_appservice.sh \ - || ynh_die "Synapse can't restart with the appservice configuration" + || ynh_die --message="Synapse can't restart with the appservice configuration" # Remove the log files ynh_secure_remove --file="/var/log/$app" diff --git a/scripts/upgrade b/scripts/upgrade index cb11539..461907b 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -135,10 +135,8 @@ $final_path/bin/python3 -m mautrix_telegram -g -c "$mautrix_config_path" -r "$ap # upgrade the alembic database # TODO remove on next upgrade # ynh_backup_if_checksum_is_different --file="$final_path/alembic.ini" -ynh_replace_string --match_string="script_location = alembic" \ - --replace_string="script_location = $final_path/alembic" \ - --target_file="$final_path/alembic.ini" -$final_path/bin/alembic -c "$final_path/alembic.ini" -x config="$mautrix_config_path" upgrade head +ynh_replace_string --match_string="script_location = alembic" --replace_string="script_location = $final_path/alembic" --target_file="$final_path/alembic.ini" +ynh_exec_warn_less $final_path/bin/alembic -c "$final_path/alembic.ini" -x config="$mautrix_config_path" upgrade head # Recalculate and store the checksum of the file for the next upgrade. ynh_store_file_checksum --file="$mautrix_config_path" @@ -190,7 +188,7 @@ ynh_systemd_action --service_name=$app --action="start" ynh_script_progression --message="Reloading synapse server..." --weight=1 /opt/yunohost/matrix-$synapse_instance/update_synapse_for_appservice.sh \ - || ynh_die "Synapse can't restart with the appservice configuration" + || ynh_die --message="Synapse can't restart with the appservice configuration" #================================================= # END OF SCRIPT