diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100644 index 9976773..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,65 +0,0 @@ -#!/bin/bash - -#================================================= -# PACKAGE UPDATING HELPER -#================================================= - -# This script is meant to be run by GitHub Actions -# The YunoHost-Apps organisation offers a template Action to run this script periodically -# Since each app is different, maintainers can adapt its contents so as to perform -# automatic actions when a new upstream release is detected. - -#================================================= -# FETCHING LATEST RELEASE AND ITS ASSETS -#================================================= - -# Fetching information -current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') -repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') -# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) -version=$(curl --silent "https://api.github.com/repos/$repo/tags" | jq -r '.[] | select( .prerelease != true ) | .name' | sort -V | tail -1) - -# Later down the script, we assume the version has only digits and dots -# Sometimes the release name starts with a "v", so let's filter it out. -# You may need more tweaks here if the upstream repository has different naming conventions. -if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then - version=${version:1} -fi - -# Setting up the environment variables -echo "Current version: $current_version" -echo "Latest release from upstream: $version" -echo "VERSION=$version" >> $GITHUB_ENV -echo "REPO=$repo" >> $GITHUB_ENV -# For the time being, let's assume the script will fail -echo "PROCEED=false" >> $GITHUB_ENV - -# Proceed only if the retrieved version is greater than the current one -if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then - echo "::warning ::No new version available" - exit 0 -# Proceed only if a PR for this new version does not already exist -elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then - echo "::warning ::A branch already exists for this update" - exit 0 -fi - -#================================================= -# SPECIFIC UPDATE STEPS -#================================================= - -# Any action on the app's source code can be done. -# The GitHub Action workflow takes care of committing all changes after this script ends. - -#================================================= -# GENERIC FINALIZATION -#================================================= - -# Replace new version in manifest -echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json - -# No need to update the README, yunohost-bot takes care of it - -# The Action will proceed only if the PROCEED environment variable is set to true -echo "PROCEED=true" >> $GITHUB_ENV -exit 0 diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index a56d7cb..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,49 +0,0 @@ -# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. -# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. -# This file should be enough by itself, but feel free to tune it to your needs. -# It calls updater.sh, which is where you should put the app-specific update steps. -name: Check for new upstream releases -on: - # Allow to manually trigger the workflow - workflow_dispatch: - # Run it every day at 6:00 UTC - schedule: - - cron: '0 6 * * *' -jobs: - updater: - runs-on: ubuntu-latest - steps: - - name: Fetch the source code - uses: actions/checkout@v3 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Run the updater script - id: run_updater - run: | - # Setting up Git user - git config --global user.name 'yunohost-bot' - git config --global user.email 'yunohost-bot@users.noreply.github.com' - # Run the updater script - /bin/bash .github/workflows/updater.sh - - name: Commit changes - id: commit - if: ${{ env.PROCEED == 'true' }} - run: | - git commit -am "Upgrade to v$VERSION" - - name: Create Pull Request - id: cpr - if: ${{ env.PROCEED == 'true' }} - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update to version ${{ env.VERSION }} - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - signoff: false - base: testing - branch: ci-auto-update-v${{ env.VERSION }} - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to v${{ env.VERSION }} - draft: false diff --git a/README.md b/README.md index a6fd795..1124420 100644 --- a/README.md +++ b/README.md @@ -16,77 +16,23 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -A groupware (webmail, adressbook, calendar) witch use PHP - +Horde Groupware Webmail Edition is a free, enterprise ready, browser based communication suite. Users can read, send and organize email messages and manage and share calendars, contacts, tasks and notes with the standards compliant components from the Horde Project. **Shipped version:** 5.2.23~ynh1 -**Demo:** http://demo.horde.org +**Demo:** ## Screenshots ![Screenshot of Horde](./doc/screenshots/screenshot.png) -## Disclaimers / important information - -### Customisation - -#### Install others app. - -The package provide some apps, but it's could be possible to install some others apps. The list of all availabe apps are listed here : https://www.horde.org/apps - -Before any change it's recommended to make a backup : -```bash -# In case of multiple instance adapt "horde" by the horde instance -sudo yunohost backup create --verbose --ignore-system --apps horde -``` - -Install horde apps with pear : - -```bash -# Get the horde final_path -# In case of multiple instance adapt "horde" by the horde instance -final_path=$(yunohost app setting horde final_path) - -# Set the pear command to call to stay in the horde environnement (not in the global system environnement) -pear_cmd="$final_path/pear/pear -c $final_path/pear.conf" - -# Update the pear channel -$pear_cmd channel-update pear.horde.org - -# Install the app that you want -$pear_cmd install -a -B horde/APP_TO_INSTALL - -# Set the final permission -# In case of multiple instance adapt "horde" by the horde instance -chown -R www-data:horde $final_path - -``` - -After you need to update the horde database schema and the horde config. So go on the horde config pannel (in the settings wheel > Preferences > Administration > Configuration). Click on "Update all DB schemas" and then on "Update all configurations". - -Now you should be able to use the new apps. - -### ActiveSync - -For calendar, task and addressbook activeSync has been configured but not yet tested. - -### Troubleshotting - -**Get Address is missing domain while to try to send an email.** - -- You need to create an identity before send an email. -- To create this go in the settings wheel > Preferences > Global Preferences > Personal Information. -- Complete the form and save it. -- You might be able to sed an email now. - ## Documentation and resources -* Official app website: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info @@ -94,10 +40,10 @@ Please send your pull request to the [testing branch](https://github.com/YunoHos To try the testing branch, please proceed like that. -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/horde_ynh/tree/testing --debug or sudo yunohost app upgrade horde -u https://github.com/YunoHost-Apps/horde_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index c7fb971..a5eb72a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,77 +16,23 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -A groupware (webmail, adressbook, calendar) witch use PHP - +Horde Groupware Webmail Edition est une suite de communication gratuite, adaptée aux entreprises et basée sur un navigateur. Les utilisateurs peuvent lire, envoyer et organiser des messages électroniques et gérer et partager des calendriers, des contacts, des tâches et des notes avec les composants conformes aux normes du projet Horde. **Version incluse :** 5.2.23~ynh1 -**Démo :** http://demo.horde.org +**Démo :** ## Captures d’écran ![Capture d’écran de Horde](./doc/screenshots/screenshot.png) -## Avertissements / informations importantes - -### Customisation - -#### Install others app. - -The package provide some apps, but it's could be possible to install some others apps. The list of all availabe apps are listed here : https://www.horde.org/apps - -Before any change it's recommended to make a backup : -```bash -# In case of multiple instance adapt "horde" by the horde instance -sudo yunohost backup create --verbose --ignore-system --apps horde -``` - -Install horde apps with pear : - -```bash -# Get the horde final_path -# In case of multiple instance adapt "horde" by the horde instance -final_path=$(yunohost app setting horde final_path) - -# Set the pear command to call to stay in the horde environnement (not in the global system environnement) -pear_cmd="$final_path/pear/pear -c $final_path/pear.conf" - -# Update the pear channel -$pear_cmd channel-update pear.horde.org - -# Install the app that you want -$pear_cmd install -a -B horde/APP_TO_INSTALL - -# Set the final permission -# In case of multiple instance adapt "horde" by the horde instance -chown -R www-data:horde $final_path - -``` - -After you need to update the horde database schema and the horde config. So go on the horde config pannel (in the settings wheel > Preferences > Administration > Configuration). Click on "Update all DB schemas" and then on "Update all configurations". - -Now you should be able to use the new apps. - -### ActiveSync - -For calendar, task and addressbook activeSync has been configured but not yet tested. - -### Troubleshotting - -**Get Address is missing domain while to try to send an email.** - -- You need to create an identity before send an email. -- To create this go in the settings wheel > Preferences > Global Preferences > Personal Information. -- Complete the form and save it. -- You might be able to sed an email now. - ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs @@ -94,10 +40,10 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour essayer la branche testing, procédez comme suit. -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/horde_ynh/tree/testing --debug ou sudo yunohost app upgrade horde -u https://github.com/YunoHost-Apps/horde_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/check_process b/check_process deleted file mode 100644 index ac2ef6b..0000000 --- a/check_process +++ /dev/null @@ -1,29 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - language="fr" - admin="john" - service_autodiscovery=1 - whups_install=1 - sesha_install=1 - ansel_install=1 - wicked_install=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 5.2.22~ynh4 - upgrade=1 from_commit=88e078661c230a9fe694624367b4b152950ae894 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none diff --git a/conf/config_horde.exp b/conf/config_horde.exp index 572d7ab..1730e00 100644 --- a/conf/config_horde.exp +++ b/conf/config_horde.exp @@ -1,13 +1,13 @@ #!/usr/bin/expect set timeout 10 -set final_path [lindex $argv 0] +set install_dir [lindex $argv 0] set db_name [lindex $argv 1] set db_user [lindex $argv 2] set db_password [lindex $argv 3] set admin_user [lindex $argv 4] -spawn php -d include_path=$final_path/pear/php $final_path/pear/webmail-install +spawn php -d include_path=$install_dir/pear/php $install_dir/pear/webmail-install expect "What database backend should we use?" send "mysql\r"; diff --git a/conf/extra_php-fpm.conf b/conf/extra_php-fpm.conf new file mode 100644 index 0000000..d9c9469 --- /dev/null +++ b/conf/extra_php-fpm.conf @@ -0,0 +1,7 @@ +; Special settings for Horde + +php_value[include_path] = "__INSTALL_DIR__/pear/php:.:__INSTALL_DIR__/horde/lib" +env[PHP_PEAR_SYSCONF_DIR] = __INSTALL_DIR__ + +php_value[session.gc_divisor] = 20000 +php_value[session.gc_probability] = 1 diff --git a/conf/gollem_backends.php b/conf/gollem_backends.php index 39f4761..0a560b2 100644 --- a/conf/gollem_backends.php +++ b/conf/gollem_backends.php @@ -103,7 +103,7 @@ $backends['file'] = array( 'hordeauth' => true, 'params' => array( // The base location under which the user home directories live. - 'vfsroot' => '__GOLLEM_DATA_DIR__', + 'vfsroot' => '__DATA_DIR__', // The default permissions to set for newly created folders and files. // 'permissions' => '750' ), diff --git a/conf/horde_conf.php b/conf/horde_conf.php index 005a002..3a87bd7 100644 --- a/conf/horde_conf.php +++ b/conf/horde_conf.php @@ -34,7 +34,7 @@ $conf['sql']['logqueries'] = false; $conf['sql']['phptype'] = 'mysql'; $conf['nosql']['phptype'] = false; $conf['ldap']['useldap'] = false; -$conf['auth']['admins'] = array('__ADMIN_USER__'); +$conf['auth']['admins'] = array('__ADMIN__'); $conf['auth']['checkip'] = true; $conf['auth']['checkbrowser'] = true; $conf['auth']['resetpassword'] = false; @@ -99,7 +99,7 @@ $conf['mailer']['params']['password_auth'] = true; $conf['mailer']['params']['auth'] = true; $conf['mailer']['params']['lmtp'] = false; $conf['mailer']['type'] = 'smtp'; -$conf['vfs']['params']['vfsroot'] = '__FINAL_PATH__/data'; +$conf['vfs']['params']['vfsroot'] = '__INSTALL_DIR__/data'; $conf['vfs']['type'] = 'File'; $conf['sessionhandler']['type'] = 'Builtin'; $conf['sessionhandler']['hashtable'] = false; @@ -110,7 +110,7 @@ $conf['nobase64_img'] = false; $conf['image']['driver'] = 'Imagick'; $conf['exif']['driver'] = 'Bundled'; $conf['timezone']['location'] = 'ftp://ftp.iana.org/tz/tzdata-latest.tar.gz'; -$conf['problems']['email'] = '__ADMIN_USER__@__DOMAIN__'; +$conf['problems']['email'] = '__ADMIN__@__DOMAIN__'; $conf['problems']['maildomain'] = '__DOMAIN__'; $conf['problems']['tickets'] = false; $conf['problems']['attachments'] = true; diff --git a/conf/init_horde_install.exp b/conf/init_horde_install.exp index 8aacdde..7bb73bb 100644 --- a/conf/init_horde_install.exp +++ b/conf/init_horde_install.exp @@ -1,10 +1,10 @@ #!/usr/bin/expect set timeout 10 -set final_path [lindex $argv 0] +set install_dir [lindex $argv 0] set horde_path [lindex $argv 1] -spawn $final_path/pear/pear -c $final_path/pear.conf run-scripts horde/horde_role +spawn $install_dir/pear/pear -c $install_dir/pear.conf run-scripts horde/horde_role expect "Filesystem location for the base Horde application" send "$horde_path\r"; diff --git a/conf/nginx.conf b/conf/nginx.conf index cbee582..0316a43 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/horde/; + alias __INSTALL_DIR__/horde/; index index.php; diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf deleted file mode 100644 index 38fbc33..0000000 --- a/conf/php-fpm.conf +++ /dev/null @@ -1,437 +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 = 10 - -; 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 = /var/log/nginx/__NAMETOCHANGE__.slow.log - -; 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 = 5s - -; 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 - -; Special settings for Horde -php_value[include_path] = "__FINALPATH__/pear/php:.:__FINALPATH__/horde/lib" -env[PHP_PEAR_SYSCONF_DIR] = __FINALPATH__ - -php_value[session.gc_divisor] = 20000 -php_value[session.gc_probability] = 1 diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 91% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index aeec11a..f9a51ce 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -45,6 +45,6 @@ For calendar, task and addressbook activeSync has been configured but not yet te **Get Address is missing domain while to try to send an email.** - You need to create an identity before send an email. -- To create this go in the settings wheel > Preferences > Global Preferences > Personal Information. +- To create this, go in the settings wheel > Preferences > Global Preferences > Personal Information. - Complete the form and save it. -- You might be able to sed an email now. +- You should be able to send an email now. diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index e91a70d..4694989 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1 @@ -A groupware (webmail, adressbook, calendar) witch use PHP +Horde Groupware Webmail Edition is a free, enterprise ready, browser based communication suite. Users can read, send and organize email messages and manage and share calendars, contacts, tasks and notes with the standards compliant components from the Horde Project. diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..fb15439 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1 @@ +Horde Groupware Webmail Edition est une suite de communication gratuite, adaptée aux entreprises et basée sur un navigateur. Les utilisateurs peuvent lire, envoyer et organiser des messages électroniques et gérer et partager des calendriers, des contacts, des tâches et des notes avec les composants conformes aux normes du projet Horde. diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 27ec913..0000000 --- a/manifest.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "name": "Horde", - "id": "horde", - "packaging_format": 1, - "description": { - "en": "Groupware (webmail, adressbook, calendar)", - "fr": "Groupware (webmail, carnet adresses, agenda)" - }, - "version": "5.2.23~ynh1", - "url": "https://www.horde.org/", - "upstream": { - "license": "LGPL-2.0", - "website": "https://www.horde.org", - "demo": "http://demo.horde.org", - "admindoc": "https://wiki.horde.org", - "code": "https://github.com/horde/base" - }, - "license": "LGPL-2.0", - "maintainer": { - "name": "Josué Tille", - "email": "josue@tille.ch" - }, - "requirements": { - "yunohost": ">= 11.0.9" - }, - "multi_instance": true, - "services": [ - "nginx", - "php7.4-fpm", - "mysql" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/horde", - "default": "/horde" - }, - { - "name": "is_public", - "type": "boolean", - "default": false - }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": [ - "bg", - "de", - "en", - "es", - "fi", - "fo", - "fr", - "hr", - "hu", - "id", - "is", - "it", - "lt", - "lv", - "mg", - "mk", - "mt", - "nl", - "pl", - "pt", - "ro", - "ru", - "sk", - "so", - "th", - "tr", - "uz" - ], - "default": "en" - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "service_autodiscovery", - "type": "boolean", - "ask": { - "en": "Would you like to enable the caldDav/cardDAV service autodiscovery?", - "fr": "Voulez-vous activer l'autodécouverte des services calDAV/cardDAV?" - }, - "default": false - }, - { - "name": "whups_install", - "type": "boolean", - "ask": { - "en": "Install a ticket-tracking system (Whups)?" - }, - "default": false - }, - { - "name": "sesha_install", - "type": "boolean", - "ask": { - "en": "Install a Inventory Manager (Sesha)?" - }, - "default": false - }, - { - "name": "ansel_install", - "type": "boolean", - "ask": { - "en": "Install a full featured photo management (Ansel)?" - }, - "default": false - }, - { - "name": "wicked_install", - "type": "boolean", - "ask": { - "en": "Install a Wiki (Wicked)?" - }, - "default": false - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..d0578ae --- /dev/null +++ b/manifest.toml @@ -0,0 +1,95 @@ +packaging_format = 2 + +id = "horde" +name = "Horde" +description.en = "Groupware (webmail, adressbook, calendar)" +description.fr = "Groupware (webmail, carnet adresses, agenda)" + +version = "5.2.23~ynh1" + +maintainers = [] + +[upstream] +license = "LGPL-2.0" +website = "https://www.horde.org" +demo = "http://demo.horde.org" +admindoc = "https://wiki.horde.org" +code = "https://github.com/horde/base" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "50M" +ram.build = "500M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/horde" + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.language] + ask.en = "Choose the application language" + ask.fr = "Choisissez la langue de l'application" + type = "select" + choices = ["bg", "de", "en", "es", "fi", "fo", "fr", "hr", "hu", "id", "is", "it", "lt", "lv", "mg", "mk", "mt", "nl", "pl", "pt", "ro", "ru", "sk", "so", "th", "tr", "uz"] + default = "en" + + [install.admin] + type = "user" + + [install.service_autodiscovery] + ask.en = "Enable the caldDav/cardDAV service autodiscovery?" + ask.fr = "Activer l'autodécouverte des services calDAV/cardDAV ?" + type = "boolean" + default = false + + [install.whups_install] + ask.en = "Install a ticket-tracking system (Whups)?" + ask.fr = "Installer un système de suivi des tickets (Whups) ?" + type = "boolean" + default = false + + [install.sesha_install] + ask.en = "Install a Inventory Manager (Sesha)?" + ask.fr = "Installer un gestionnaire d'inventaire (Sesha) ?" + type = "boolean" + default = false + + [install.ansel_install] + ask.en = "Install a full featured photo management (Ansel)?" + ask.fr = "Installer un gestion de photos (Ansel) ?" + type = "boolean" + default = false + + [install.wicked_install] + ask.en = "Install a Wiki (Wicked)?" + ask.fr = "Installer un Wiki (Wicked) ?" + type = "boolean" + default = false + +[resources] + [resources.system_user] + + [resources.install_dir] + + [resources.data_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "mariadb-server, php-pear, php7.4-imagick, php7.4-tidy, php7.4-bcmath, expect" + + [resources.database] + type = "mysql" diff --git a/scripts/_common.sh b/scripts/_common.sh index 1c226dc..3727690 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,55 +6,22 @@ # PHP APP SPECIFIC #================================================= -YNH_PHP_VERSION="7.4" - -php_dependencies="php-pear php$YNH_PHP_VERSION-imagick php$YNH_PHP_VERSION-tidy php$YNH_PHP_VERSION-bcmath" - -# dependencies used by the app (must be on a single line) -pkg_dependencies="expect php-pear $php_dependencies" - #================================================= # PERSONAL HELPERS #================================================= patch_app() { local old_dir=$(pwd) - (cd "$final_path/horde" && patch -p1 < $YNH_CWD/../sources/sso_auth.patch) || echo "Unable to apply patches" + (cd "$install_dir/horde" && patch -p1 < $YNH_CWD/../sources/sso_auth.patch) || echo "Unable to apply patches" cd $old_dir } config_horde() { - ynh_backup_if_checksum_is_different --file "$final_path/horde/config/conf.php" - ynh_backup_if_checksum_is_different --file "$final_path/horde/imp/config/conf.php" - ynh_backup_if_checksum_is_different --file "$final_path/horde/config/registry.local.php" - ynh_backup_if_checksum_is_different --file "$final_path/horde/gollem/config/backends.local.php" - ynh_backup_if_checksum_is_different --file "$final_path/horde/ingo/config/backends.local.php" - - cp ../conf/horde_conf.php "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __DOMAIN__ --replace_string "$domain" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __PATH__ --replace_string "$path_url" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __FINAL_PATH__ --replace_string "$final_path" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __DB_NAME__ --replace_string "$db_name" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __DB_USER__ --replace_string "$db_user" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __DB_PWD__ --replace_string "$db_pwd" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __ADMIN_USER__ --replace_string "$admin" --target_file "$final_path/horde/config/conf.php" - ynh_replace_string --match_string __SECRET_KEY__ --replace_string "$secret_key" --target_file "$final_path/horde/config/conf.php" - - cp ../conf/horde_imp_conf.php "$final_path/horde/imp/config/conf.php" - - cp ../conf/horde_registry.php "$final_path/horde/config/registry.local.php" - ynh_replace_string --match_string __PATH__ --replace_string "$path_url" --target_file "$final_path/horde/config/registry.local.php" - - cp ../conf/gollem_backends.php "$final_path/horde/gollem/config/backends.local.php" - ynh_replace_string --match_string __GOLLEM_DATA_DIR__ --replace_string "$gollem_data_dir" --target_file "$final_path/horde/gollem/config/backends.local.php" - - cp ../conf/ingo_backends.php "$final_path/horde/ingo/config/backends.local.php" - - ynh_store_file_checksum --file "$final_path/horde/config/conf.php" - ynh_store_file_checksum --file "$final_path/horde/imp/config/conf.php" - ynh_store_file_checksum --file "$final_path/horde/config/registry.local.php" - ynh_store_file_checksum --file "$final_path/horde/gollem/config/backends.local.php" - ynh_store_file_checksum --file "$final_path/horde/ingo/config/backends.local.php" + ynh_add_config --template="horde_conf.php" --destination="$install_dir/horde/config/conf.php" + ynh_add_config --template="/horde_imp_conf.php" --destination="$install_dir/horde/imp/config/conf.php" + ynh_add_config --template="horde_registry.php" --destination="$install_dir/horde/config/registry.local.php" + ynh_add_config --template="gollem_backends.php" --destination="$install_dir/horde/gollem/config/backends.local.php" + ynh_add_config --template="ingo_backends.php" --destination="$install_dir/horde/ingo/config/backends.local.php" } config_nginx() { @@ -67,36 +34,36 @@ add_nginx_autodiscovery() { nginx_domain_path=/etc/nginx/conf.d/$domain.d/* nginx_config_path="/etc/nginx/conf.d/$domain.d/$app.conf" grep "/Microsoft-Server-ActiveSync" $nginx_domain_path || echo "location /Microsoft-Server-ActiveSync { - return 301 https://\$server_name$path_url/rpc.php; + return 301 https://\$server_name$path/rpc.php; } " >> "$nginx_config_path" grep "/autodiscover/autodiscover.xml" $nginx_domain_path || echo "location /autodiscover/autodiscover.xml { - return 301 https://\$server_name$path_url/rpc.php; + return 301 https://\$server_name$path/rpc.php; } " >> "$nginx_config_path" grep "/Autodiscover/Autodiscover.xml" $nginx_domain_path || echo "location /Autodiscover/Autodiscover.xml { - return 301 https://\$server_name$path_url/rpc.php; + return 301 https://\$server_name$path/rpc.php; } " >> "$nginx_config_path" grep "/.well-known/caldav" $nginx_domain_path || echo "location /.well-known/caldav { - return 301 https://\$server_name$path_url/rpc.php; + return 301 https://\$server_name$path/rpc.php; } " >> "$nginx_config_path" grep "/.well-known/carddav" $nginx_domain_path || echo "location /.well-known/carddav { - return 301 https://\$server_name$path_url/rpc.php; + return 301 https://\$server_name$path/rpc.php; } " >> "$nginx_config_path" } set_permission() { - chown -R www-data:$app $final_path - chown -R www-data:$app $gollem_data_dir - chmod u=rwX,g=rwX,o= -R $final_path - chmod u=rwX,g=rwX,o= -R $gollem_data_dir + chown -R www-data:$app $install_dir + chown -R www-data:$app $data_dir + chmod u=rwX,g=rwX,o= -R $install_dir + chmod u=rwX,g=rwX,o= -R $data_dir } #================================================= diff --git a/scripts/backup b/scripts/backup index 25968d8..7792996 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,29 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -gollem_data_dir=$(ynh_app_setting_get --app=$app --key=gollem_data_dir) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -42,13 +19,13 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE DATA DIR #================================================= -ynh_backup --src_path="$gollem_data_dir" +ynh_backup --src_path="$data_dir" --is_big #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 45a63ba..efa8f02 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,69 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -# Add settings here as needed by your application -admin=$(ynh_app_setting_get --app=$app --key=admin) -port=$(ynh_app_setting_get --app=$app --key=port) -secret_key=$(ynh_app_setting_get --app=$app --key=secret_key) -service_autodiscovery=$(ynh_app_setting_get --app=$app --key=service_autodiscovery) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -gollem_data_dir=$(ynh_app_setting_get --app=$app --key=gollem_data_dir) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -79,33 +16,7 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - -domain=$new_domain -path_url=$new_path -config_nginx +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS @@ -116,15 +27,6 @@ ynh_script_progression --message="Configuring application..." --weight=3 config_horde -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index 7d16e63..a1fd04c 100755 --- a/scripts/install +++ b/scripts/install @@ -10,58 +10,9 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# OPTIONAL APPS #================================================= -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -language=$YNH_APP_ARG_LANGUAGE -admin=$YNH_APP_ARG_ADMIN -service_autodiscovery=$YNH_APP_ARG_SERVICE_AUTODISCOVERY -whups_install=$YNH_APP_ARG_WHUPS_INSTALL -sesha_install=$YNH_APP_ARG_SESHA_INSTALL -ansel_install=$YNH_APP_ARG_ANSEL_INSTALL -wicked_install=$YNH_APP_ARG_WICKED_INSTALL - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=language --value=$language -ynh_app_setting_set --app=$app --key=admin --value=$admin -ynh_app_setting_set --app=$app --key=service_autodiscovery --value=$service_autodiscovery -ynh_app_setting_set --app=$app --key=whups_install --value=$whups_install -ynh_app_setting_set --app=$app --key=sesha_install --value=$sesha_install -ynh_app_setting_set --app=$app --key=ansel_install --value=$ansel_install -ynh_app_setting_set --app=$app --key=wicked_install --value=$wicked_install - # Set list of optionnal app to install optionnal_apps_list="" @@ -98,77 +49,29 @@ then locale-gen fi -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=7 - -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=$app --home_dir="$final_path" - -#================================================= -# CREATE A MYSQL DATABASE -#================================================= -ynh_script_progression --message="Creating a MySQL database..." --weight=1 - -db_name=$(ynh_sanitize_dbid --db_name=$app) -db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=1 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -mkdir $final_path -mkdir $final_path/data +mkdir $install_dir/data -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= -# PHP-FPM CONFIGURATION +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring PHP-FPM..." --weight=1 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 # Create a dedicated PHP-FPM config ynh_add_fpm_config -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." - # Create a dedicated NGINX config config_nginx -#================================================= -# SPECIFIC SETUP -#================================================= -# CREATE DATA DIRECTORY -#================================================= -ynh_script_progression --message="Creating a data directory..." - -gollem_data_dir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=gollem_data_dir --value=$gollem_data_dir - -mkdir -p $gollem_data_dir - -chmod 750 "$gollem_data_dir" -chmod -R o-rwx "$gollem_data_dir" -chown -R $app:www-data "$gollem_data_dir" - #================================================= # INSTALL SOURCE FILES #================================================= @@ -178,24 +81,24 @@ ynh_script_progression --message="Installing sources files..." --weight=7 chmod +x ../conf/init_horde_install.exp chmod +x ../conf/config_horde.exp -pear config-create "$final_path" "$final_path/pear.conf" -pear -c "$final_path/pear.conf" install -o -f pear +pear config-create "$install_dir" "$install_dir/pear.conf" +pear -c "$install_dir/pear.conf" install -o -f pear -pear_cmd="$final_path/pear/pear -c $final_path/pear.conf" +pear_cmd="$install_dir/pear/pear -c $install_dir/pear.conf" $pear_cmd config-set auto_discover 1 -$pear_cmd config-set data_dir $final_path/data +$pear_cmd config-set data_dir $install_dir/data $pear_cmd channel-discover pear.horde.org $pear_cmd install horde/horde_role -../conf/init_horde_install.exp "$final_path" "$final_path/horde" +../conf/init_horde_install.exp "$install_dir" "$install_dir/horde" -$pear_cmd config-set horde_dir "$final_path/horde" +$pear_cmd config-set horde_dir "$install_dir/horde" $pear_cmd install -a -B horde/webmail $optionnal_apps_list -PHP_PEAR_SYSCONF_DIR=$final_path ../conf/config_horde.exp "$final_path" "$db_name" "$db_user" "$db_pwd" "$admin" -secret_key=$(grep 'secret_key' "$final_path/horde/config/conf.php" | cut -d"'" -f4) +PHP_PEAR_SYSCONF_DIR=$install_dir ../conf/config_horde.exp "$install_dir" "$db_name" "$db_user" "$db_pwd" "$admin" +secret_key=$(grep 'secret_key' "$install_dir/horde/config/conf.php" | cut -d"'" -f4) ynh_app_setting_set --app=$app --key=secret_key --value="$secret_key" #================================================= @@ -215,7 +118,7 @@ config_horde #================================================= # SECURE FILES AND DIRECTORIES #================================================= -ynh_script_progression --message="Protecting directory..." +ynh_script_progression --message="Protecting directory..." --weight=1 set_permission @@ -226,28 +129,9 @@ set_permission #================================================= ynh_script_progression --message="Configuring log rotation..." --weight=1 -ynh_use_logrotate --logfile="$final_path/horde" --nonappend --specific_user www-data/horde -ynh_use_logrotate --logfile="$final_path/horde/services" --specific_user www-data/horde -ynh_use_logrotate --logfile="$final_path/horde/services/portal" --specific_user www-data/horde - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -if [ "$is_public" = "0" ]; -then # Retire l'accès public - ynh_app_setting_delete --app=$app --key=skipped_uris -else - ynh_app_setting_set --app=$app --key=unprotected_uris --value="/" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_use_logrotate --logfile="$install_dir/horde" --nonappend --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde/services" --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde/services/portal" --specific_user www-data/horde #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index f74d710..1387cb0 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,19 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -port=$(ynh_app_setting_get --app=$app --key=port) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - #================================================= # STANDARD REMOVE #================================================= @@ -32,65 +19,12 @@ ynh_script_progression --message="Removing logrotate configuration..." --weight= # Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# REMOVE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Removing the MySQL database..." --weight=1 - -# Remove a database if it exists, along with the associated user -ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name - -#================================================= -# 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 NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 - # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=1 - # Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=1 - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - -#================================================= -# SPECIFIC REMOVE -#================================================= -# REMOVE VARIOUS FILES -#================================================= -ynh_script_progression --message="Removing various files..." --weight=1 - -ynh_secure_remove --file="$gollem_data_dir" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 9aba51d..de2a5e1 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,74 +10,29 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -gollem_data_dir=$(ynh_app_setting_get --app=$app --key=gollem_data_dir) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" #================================================= # RESTORE THE DATA DIRECTORY #================================================= ynh_script_progression --message="Restoring the data directory..." --weight=1 -ynh_restore_file --origin_path="$gollem_data_dir" +ynh_restore_file --origin_path="$data_dir" --not_mandatory -mkdir -p $gollem_data_dir +# (Same as for install dir) +chown -R $app:www-data "$data_dir" #================================================= -# SPECIFIC RESTORATION +# RESTORE THE MYSQL DATABASE #================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=5 +ynh_script_progression --message="Restoring the MySQL database..." --weight=1 -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies +ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql #================================================= # RESTORE THE PHP-FPM CONFIGURATION @@ -86,22 +41,8 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1 - ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# RESTORE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Restoring the MySQL database..." --weight=1 - -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd -ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql - #================================================= # RESTORE VARIOUS FILES #================================================= @@ -114,9 +55,9 @@ set_permission #================================================= ynh_script_progression --message="Restoring the logrotate configuration..." --weight=1 -ynh_use_logrotate --logfile="$final_path/horde" --nonappend --specific_user www-data/horde -ynh_use_logrotate --logfile="$final_path/horde/services" --specific_user www-data/horde -ynh_use_logrotate --logfile="$final_path/horde/services/portal" --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde" --nonappend --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde/services" --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde/services/portal" --specific_user www-data/horde #================================================= # GENERIC FINALIZATION diff --git a/scripts/upgrade b/scripts/upgrade index 3241fc5..7246a06 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,81 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -admin=$(ynh_app_setting_get --app=$app --key=admin) -service_autodiscovery=$(ynh_app_setting_get --app=$app --key=service_autodiscovery) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -port=$(ynh_app_setting_get --app=$app --key=port) -secret_key=$(ynh_app_setting_get --app=$app --key=secret_key) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -gollem_data_dir=$(ynh_app_setting_get --app=$app --key=gollem_data_dir) - #================================================= # CHECK VERSION #================================================= -ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# STANDARD UPGRADE STEPS -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -# If final_path doesn't exist, create it -if [ -z "$gollem_data_dir" ]; then - gollem_data_dir=/home/yunohost.app/$app - ynh_app_setting_set --app=$app --key=gollem_data_dir --value=$gollem_data_dir -fi - -#================================================= -# 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=$app --home_dir="$final_path" - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=1 - -ynh_install_app_dependencies $pkg_dependencies - #================================================= # PHP-FPM CONFIGURATION #================================================= @@ -92,11 +23,6 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1 # Create a dedicated PHP-FPM config ynh_add_fpm_config -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 - # Create a dedicated NGINX config config_nginx @@ -107,9 +33,9 @@ config_nginx #================================================= ynh_script_progression --message="Upgrading source files..." --weight=6 -pear_cmd="$final_path/pear/pear -c $final_path/pear.conf" +pear_cmd="$install_dir/pear/pear -c $install_dir/pear.conf" $pear_cmd channel-update pear.horde.org -$pear_cmd upgrade -R $final_path -a -B -c pear.horde.org || true +$pear_cmd upgrade -R $install_dir -a -B -c pear.horde.org || true #================================================= # PATCH APPLICATION @@ -139,16 +65,9 @@ set_permission #================================================= ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1 -ynh_use_logrotate --logfile="$final_path/horde" --nonappend --specific_user www-data/horde -ynh_use_logrotate --logfile="$final_path/horde/services" --specific_user www-data/horde -ynh_use_logrotate --logfile="$final_path/horde/services/portal" --specific_user www-data/horde - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_use_logrotate --logfile="$install_dir/horde" --nonappend --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde/services" --specific_user www-data/horde +ynh_use_logrotate --logfile="$install_dir/horde/services/portal" --specific_user www-data/horde #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..7073883 --- /dev/null +++ b/tests.toml @@ -0,0 +1,10 @@ +test_format = 1.0 + +[default] + + + args.service_autodiscovery=1 + args.whups_install=1 + args.sesha_install=1 + args.ansel_install=1 + args.wicked_install=1 \ No newline at end of file