Merge pull request #24 from YunoHost-Apps/5.4.5

Updated to version 5.4.6 and modify .env from source itself

README.md

@@ -9,7 +9,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 ## Overview
 "Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. You can [read all about it in the main repository](https://github.com/firefly-iii/firefly-iii) and in the [official documentation](https://firefly-iii.readthedocs.io/en/latest/).
 
-**Shipped version:** 5.2.0
+**Shipped version:** 5.4.6
 
 ## Screenshots
 
@@ -51,8 +51,7 @@ TODO
 
 ---
 
-Developer info
+## Developer info
-----------------
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing).
 

check_process

@@ -17,10 +17,9 @@
         setup_private=1
         setup_public=1
         upgrade=1
+        upgrade=1	from_commit=66140e9d21f8d9e07074b5bded213265b06819d5
         backup_restore=1
         multi_instance=1
-		# This test is no longer necessary since the version 2.7 (PR: https://github.com/YunoHost/yunohost/pull/304), you can still do it if your app could be installed with this version.
-		# incorrect_path=1
         port_already_use=0
         change_url=0
 ;;; Levels

conf/.env

@@ -5,30 +5,46 @@ APP_ENV=local
 # Set to true if you want to see debug information in error screens.
 APP_DEBUG=false
 
-# This should be your email address
+# This should be your email address.
-SITE_OWNER=yunomail
+# If you use Docker or similar, you can set this variable from a file by using SITE_OWNER_FILE
+SITE_OWNER=mail@example.com
 
-# The encryption key for your database and sessions. Keep this very secure.
+# The encryption key for your sessions. Keep this very secure.
-# If you generate a new one all existing data must be considered LOST.
+# Change it to a string of exactly 32 chars or use something like `php artisan key:generate` to generate it.
-# Change it to a string of exactly 32 chars or use command `php artisan key:generate` to generate it
+# If you use Docker or similar, you can set this variable from a file by using APP_KEY_FILE
-APP_KEY=random_key
+APP_KEY=SomeRandomStringOf32CharsExactly
+
+# Firefly III will launch using this language (for new users and unauthenticated visitors)
+# For a list of available languages: https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang
+#
+# If text is still in English, remember that not everything may have been translated.
+DEFAULT_LANGUAGE=en_US
+
+# The locale defines how numbers are formatted.
+# by default this value is the same as whatever the language is.
+DEFAULT_LOCALE=equal
 
 # Change this value to your preferred time zone.
 # Example: Europe/Amsterdam
-TZ=UTC
+# For a list of supported time zones, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-
+TZ=Europe/Amsterdam
-# This variable must match your installation's external address but keep in mind that
-# it's only used on the command line as a fallback value.
-APP_URL=https://yunoappurl
 
 # TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
+# Set it to ** and reverse proxies work just fine.
 TRUSTED_PROXIES=
 
 # The log channel defines where your log entries go to.
-# 'daily' is the default logging mode giving you 5 daily rotated log files in /storage/logs/.
 # Several other options exist. You can use 'single' for one big fat error log (not recommended).
 # Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
-LOG_CHANNEL=daily
+# A rotating log option is 'daily', creates 5 files that (surprise) rotate.
+# Default setting 'stack' will log to 'daily' and to 'stdout' at the same time.
+
+# - Docker + versions <= 4.8.1.8 and before: use "stdout"
+# - Docker + versions >  4.8.1.8           : use "docker_out"
+# - Docker + versions >=  5.1.1            : use "stack"
+# - For everything else (als not Docker)   : use 'stack'
+
+LOG_CHANNEL=stack
 
 # Log level. You can set this from least severe to most severe:
 # debug, info, notice, warning, error, critical, alert, emergency
@@ -37,138 +53,277 @@ LOG_CHANNEL=daily
 APP_LOG_LEVEL=notice
 
 # Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
-# For other database types, please see the FAQ: http://firefly-iii.readthedocs.io/en/latest/support/faq.html
+# For other database types, please see the FAQ: https://docs.firefly-iii.org/support/faq
+# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
+# Use "pgsql" for PostgreSQL
+# Use "mysql" for MySQL and MariaDB.
+# Use "sqlite" for SQLite.
 DB_CONNECTION=mysql
-DB_HOST=127.0.0.1
+DB_HOST=fireflyiiidb
 DB_PORT=3306
-DB_DATABASE=yunobase
+DB_DATABASE=firefly
-DB_USERNAME=yunouser
+DB_USERNAME=firefly
-DB_PASSWORD=yunopass
+DB_PASSWORD=secret_firefly_password
+
+# MySQL supports SSL. You can configure it here.
+# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
+MYSQL_USE_SSL=false
+MYSQL_SSL_VERIFY_SERVER_CERT=true
+# You need to set at least of these options
+MYSQL_SSL_CAPATH=/etc/ssl/certs/
+MYSQL_SSL_CA=
+MYSQL_SSL_CERT=
+MYSQL_SSL_KEY=
+MYSQL_SSL_CIPHER=
+
+# PostgreSQL supports SSL. You can configure it here.
+# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
+PGSQL_SSL_MODE=prefer
+PGSQL_SSL_ROOT_CERT=null
+PGSQL_SSL_CERT=null
+PGSQL_SSL_KEY=null
+PGSQL_SSL_CRL_FILE=null
 
 # If you're looking for performance improvements, you could install memcached.
 CACHE_DRIVER=file
 SESSION_DRIVER=file
 
-# You can configure another file storage backend if you cannot use the local storage option.
+# If you set either of these to 'redis', you might want to update these settings too
-# To set this up, fill in the following variables. The upload path is used to store uploaded
+# If you use Docker or similar, you can set REDIS_HOST_FILE, REDIS_PASSWORD_FILE or
-# files and the export path is to store exported data (before download).
+# REDIS_PORT_FILE to set the value from a file instead of from an environment variable
-SFTP_HOST=
-SFTP_PORT=
-SFTP_UPLOAD_PATH=
-SFTP_EXPORT_PATH=
 
-# SFTP uses either the username/password combination or the private key to authenticate.
+# can be tcp, unix or http
-SFTP_USERNAME=
+REDIS_SCHEME=tcp
-SFTP_PASSWORD=
+
-SFTP_PRIV_KEY=
+# use only when using 'unix' for REDIS_SCHEME. Leave empty otherwise.
+REDIS_PATH=
+
+# use only when using 'tcp' or 'http' for REDIS_SCHEME. Leave empty otherwise.
+REDIS_HOST=127.0.0.1
+REDIS_PORT=6379
+
+REDIS_PASSWORD=null
+# always use quotes and make sure redis db "0" and "1" exists. Otherwise change accordingly.
+REDIS_DB="0"
+REDIS_CACHE_DB="1"
 
 # Cookie settings. Should not be necessary to change these.
+# If you use Docker or similar, you can set COOKIE_DOMAIN_FILE to set
+# the value from a file instead of from an environment variable
 COOKIE_PATH="/"
 COOKIE_DOMAIN=
 COOKIE_SECURE=false
 
 # If you want Firefly III to mail you, update these settings
-# For instructions, see: https://firefly-iii.readthedocs.io/en/latest/installation/mail.html
+# For instructions, see: https://docs.firefly-iii.org/advanced-installation/email
-MAIL_DRIVER=mail
+# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-MAIL_HOST=127.0.0.1
+MAIL_MAILER=log
-MAIL_PORT=25
+MAIL_HOST=null
-MAIL_FROM=firefly@yunodomain
+MAIL_PORT=2525
+MAIL_FROM=changeme@example.com
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 
 # Other mail drivers:
+# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MAILGUN_DOMAIN=
 MAILGUN_SECRET=
+
+
+# If you are on EU region in mailgun, use api.eu.mailgun.net, otherwise use api.mailgun.net
+# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
+MAILGUN_ENDPOINT=api.mailgun.net
+
+# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MANDRILL_SECRET=
 SPARKPOST_SECRET=
 
 # Firefly III can send you the following messages
 SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
+SEND_LOGIN_NEW_IP_WARNING=true
 
 # These messages contain (sensitive) transaction information:
 SEND_REPORT_JOURNALS=true
 
 # Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
+# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
 MAPBOX_API_KEY=
 
-# Set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
+# The map will default to this location:
-# Please note that this will only work for paid fixer.io accounts because they severly limited
+MAP_DEFAULT_LAT=51.983333
-# the free API up to the point where you might as well offer nothing.
+MAP_DEFAULT_LONG=5.916667
-FIXER_API_KEY=
+MAP_DEFAULT_ZOOM=6
-
-# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here.
-ANALYTICS_ID=
-
-# Most parts of the database are encrypted by default, but you can turn this off if you want to.
-# This makes it easier to migrate your database. Not that some fields will never be decrypted.
-USE_ENCRYPTION=false
 
 # Firefly III has two options for user authentication. "eloquent" is the default,
-# and "adldap" for LDAP servers.
+# and "ldap" for LDAP servers.
 # For full instructions on these settings please visit:
-# https://firefly-iii.readthedocs.io/en/latest/installation/authentication.html
+# https://docs.firefly-iii.org/advanced-installation/authentication
-LOGIN_PROVIDER=ldap
+# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
+LOGIN_PROVIDER=eloquent
+
+# It's also possible to change the way users are authenticated. You could use Authelia for example.
+# Authentication via the REMOTE_USER header is supported. Change the value below to "remote_user_guard".
+#
+# This will also allow Windows SSO.
+#
+# If you do this please read the documentation for instructions and warnings:
+# https://docs.firefly-iii.org/advanced-installation/authentication
+#
+# This function is available in Firefly III v5.3.0 and higher.
+AUTHENTICATION_GUARD=web
+
+# If the guard is changed, Firefly III uses the 'REMOTE_USER' header as per RFC 3875.
+# You can also use another header, like AUTH_USER when using Windows SSO.
+# Some systems use X-Auth headers. In that case, use HTTP_X_AUTH_USERNAME or HTTP_X_AUTH_EMAIL
+# Depending on your system, REMOTE_USER may need to be changed to HTTP_REMOTE_USER
+#
+# If this header is 'unexpectedly empty', check out the documentation.
+# https://docs.firefly-iii.org/advanced-installation/authentication
+#
+AUTHENTICATION_GUARD_HEADER=REMOTE_USER
+
+#
+# Firefly III uses email addresses as user identifiers. When you're using an external authentication guard
+# that doesn't do this, Firefly III is incapable of emailing you. Messages sent to "Bill Gates" always fail.
+#
+# However, if you set this value, Firefly III will store the value from this header as the user's backup
+# email address and use it to communicate. So user "Bill Gates" could still have
+# the email address "bill@microsoft.com".
+#
+# Example value: AUTHENTICATION_GUARD_EMAIL=HTTP_X_AUTH_EMAIL
+#
+AUTHENTICATION_GUARD_EMAIL=
+
+
+# It's impossible to log out users who's authentication is handled by an external system.
+# Enter a custom URL here that will force a logout (your authentication provider can tell you).
+# Setting this variable only works when AUTHENTICATION_GUARD != web
+#
+CUSTOM_LOGOUT_URI=
 
 # LDAP connection configuration
 # OpenLDAP, FreeIPA or ActiveDirectory
+# # If you use Docker or similar, you can set this variable from a file by appending it with _FILE
 ADLDAP_CONNECTION_SCHEME=OpenLDAP
 ADLDAP_AUTO_CONNECT=true
 
 # LDAP connection settings
-ADLDAP_CONTROLLERS=localhost
+# You can set the following variables from a file by appending them with _FILE:
+# ADLDAP_CONTROLLERS, ADLDAP_PORT, ADLDAP_BASEDN
+ADLDAP_CONTROLLERS=
 ADLDAP_PORT=389
 ADLDAP_TIMEOUT=5
-ADLDAP_BASEDN="dc=yunohost,dc=org"
+ADLDAP_BASEDN=""
 ADLDAP_FOLLOW_REFFERALS=false
+
+# SSL/TLS settings
 ADLDAP_USE_SSL=false
 ADLDAP_USE_TLS=false
+ADLDAP_SSL_CACERTDIR=
+ADLDAP_SSL_CACERTFILE=
+ADLDAP_SSL_CERTFILE=
+ADLDAP_SSL_KEYFILE=
+ADLDAP_SSL_CIPHER_SUITE=
+ADLDAP_SSL_REQUIRE_CERT=
 
+# You can set the following variables from a file by appending them with _FILE:
 ADLDAP_ADMIN_USERNAME=
 ADLDAP_ADMIN_PASSWORD=
 
-ADLDAP_ACCOUNT_PREFIX="uid="
+# You can set the following variables from a file by appending them with _FILE:
-ADLDAP_ACCOUNT_SUFFIX=",ou=users,dc=yunohost,dc=org"
+ADLDAP_ACCOUNT_PREFIX=
-ADLDAP_ADMIN_ACCOUNT_PREFIX=
+ADLDAP_ACCOUNT_SUFFIX=
-ADLDAP_ADMIN_ACCOUNT_SUFFIX=
 
 # LDAP authentication settings.
 ADLDAP_PASSWORD_SYNC=false
 ADLDAP_LOGIN_FALLBACK=false
 
-ADLDAP_DISCOVER_FIELD=uid
+ADLDAP_DISCOVER_FIELD=distinguishedname
-ADLDAP_AUTH_FIELD=uid
+ADLDAP_AUTH_FIELD=distinguishedname
-
-# Will allow SSO if your server provides an AUTH_USER field.
-WINDOWS_SSO_DISCOVER=samaccountname
-WINDOWS_SSO_KEY=AUTH_USER
 
 # field to sync as local username.
-ADLDAP_SYNC_FIELD=uid
+# You can set the following variable from a file by appending it with _FILE:
+ADLDAP_SYNC_FIELD=userprincipalname
 
-# You can disable the X-Frame-Options header if it interfears with tools like
+# You can disable the X-Frame-Options header if it interferes with tools like
-# Organizr. This is at your own risk.
+# Organizr. This is at your own risk. Applications running in frames run the risk
+# of leaking information to their parent frame.
 DISABLE_FRAME_HEADER=false
 
+# You can disable the Content Security Policy header when you're using an ancient browser
+# or any version of Microsoft Edge / Internet Explorer (which amounts to the same thing really)
+# This leaves you with the risk of not being able to stop XSS bugs should they ever surface.
+# This is at your own risk.
+DISABLE_CSP_HEADER=false
+
+# If you wish to track your own behavior over Firefly III, set valid analytics tracker information here.
+# Nobody uses this except for me on the demo site. But hey, feel free to use this if you want to.
+# Do not prepend the TRACKER_URL with http:// or https://
+# The only tracker supported is Matomo.
+# You can set the following variables from a file by appending them with _FILE:
+TRACKER_SITE_ID=
+TRACKER_URL=
+
+# Firefly III can collect telemetry on how you use Firefly III. This is opt-in.
+# In order to allow this, change the following variable to true.
+# To read more about this feature, go to this page: https://docs.firefly-iii.org/support/telemetry
+SEND_TELEMETRY=false
+
+# You can fine tune the start-up of a Docker container by editing these environment variables.
+# Use this at your own risk. Disabling certain checks and features may result in lost of inconsistent data.
+# However if you know what you're doing you can significantly speed up container start times.
+# Set each value to true to enable, or false to disable.
+
+# Check if the SQLite database exists. Can be skipped if you're not using SQLite.
+# Won't significantly speed up things.
+DKR_CHECK_SQLITE=true
+
+# Run database creation and migration commands. Disable this only if you're 100% sure the DB exists
+# and is up to date.
+DKR_RUN_MIGRATION=true
+
+# Run database upgrade commands. Disable this only when you're 100% sure your DB is up-to-date
+# with the latest fixes (outside of migrations!)
+DKR_RUN_UPGRADE=true
+
+# Verify database integrity. Includes all data checks and verifications.
+# Disabling this makes Firefly III assume your DB is intact.
+DKR_RUN_VERIFY=true
+
+# Run database reporting commands. When disabled, Firefly III won't go over your data to report current state.
+# Disabling this should have no impact on data integrity or safety but it won't warn you of possible issues.
+DKR_RUN_REPORT=true
+
+# Generate OAuth2 keys.
+# When disabled, Firefly III won't attempt to generate OAuth2 Passport keys. This won't be an issue, IFF (if and only if)
+# you had previously generated keys already and they're stored in your database for restoration.
+DKR_RUN_PASSPORT_INSTALL=true
+
 # Leave the following configuration vars as is.
 # Unless you like to tinker and know what you're doing.
 APP_NAME=FireflyIII
 ADLDAP_CONNECTION=default
 BROADCAST_DRIVER=log
 QUEUE_DRIVER=sync
-REDIS_HOST=127.0.0.1
-REDIS_PASSWORD=null
-REDIS_PORT=6379
 CACHE_PREFIX=firefly
-SEARCH_RESULT_LIMIT=50
 PUSHER_KEY=
 PUSHER_SECRET=
 PUSHER_ID=
 DEMO_USERNAME=
 DEMO_PASSWORD=
-IS_DOCKER=false
-IS_SANDSTORM=false
 IS_HEROKU=false
-BUNQ_USE_SANDBOX=false
+FIREFLY_III_LAYOUT=v1
-FFIII_LAYOUT=v1
+
+#
+# If you have trouble configuring your Firefly III installation, DON'T BOTHER setting this variable.
+# It won't work. It doesn't do ANYTHING. Don't believe the lies you read online. I'm not joking.
+# This configuration value WILL NOT HELP.
+#
+# This variable is ONLY used in some of the emails Firefly III sends around. Nowhere else.
+# So when configuring anything WEB related this variable doesn't do anything. Nothing
+#
+# If you're stuck I understand you get desperate but look SOMEWHERE ELSE.
+#
+APP_URL=http://localhost

conf/app.src

@@ -1,6 +1,6 @@
-SOURCE_URL=https://github.com/firefly-iii/firefly-iii/archive/5.2.0.tar.gz
+SOURCE_URL=https://github.com/firefly-iii/firefly-iii/archive/5.4.6.tar.gz
-SOURCE_SUM=136ddb92167a63e0eeafc91c18d12285e28533f18441b80a683d69cb1ea05115
+SOURCE_SUM=ff78e16c022662c0e0c29fa4092928257fedcf17d1801e0582191cfcd631e6a9
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=firefly-iii-5.2.0.tar.gz
+SOURCE_FILENAME=

conf/nginx.conf

@@ -35,5 +35,5 @@ location __PATH__/ {
 }
 
 location @rewrite {
-  rewrite ^/(.*)$ /index.php?q=$1;
+  rewrite ^__PATH__/(.*)$ __PATH__/index.php?q=$1;
 }

issue_template.md

@@ -7,7 +7,7 @@ about: Create a report to help us debug, it would be nice to fill the template a
 **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!*
+   - *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 Firefly III itself. Refer to its documentation or repository for help.*
    - *If you have a doubt, post here, we will figure it out together.*
 3. *Delete the italic comments as you write over them below, and remove this guide.*
@@ -34,8 +34,8 @@ about: Create a report to help us debug, it would be nice to fill the template a
 - *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 '....'*
+   2. *Click on '...'*
-   3. *Scroll down to '....'*
+   3. *Scroll down to '...'*
    4. *See error*
 
 **Expected behavior**

manifest.json

@@ -3,10 +3,10 @@
     "id": "firefly-iii",
     "packaging_format": 1,
     "description": {
-        "en": "A self-hosted financial manager.",
+        "en": "Self-hosted financial manager.",
-        "fr": "Un gestionnaire de finances personnelles."
+        "fr": "Gestionnaire de finances personnelles."
     },
-    "version": "5.2.0~ynh2",
+    "version": "5.4.6~ynh1",
     "url": "https://firefly-iii.org/",
     "license": "GPL-3.0-or-later",
     "maintainer": {

scripts/_common.sh

@@ -5,9 +5,9 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies=""
+pkg_dependencies="redis-server"
 
-YNH_PHP_VERSION="7.3"
+YNH_PHP_VERSION="7.4"
 
 extra_php_dependencies="php${YNH_PHP_VERSION}-zip php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-intl php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-curl php${YNH_PHP_VERSION}-bcmath php${YNH_PHP_VERSION}-opcache php${YNH_PHP_VERSION}-ldap"
 

scripts/change_url

@@ -38,7 +38,7 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up the app before changing its url (may take a while)..."
+ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..."
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -73,14 +73,14 @@ fi
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
-ynh_script_progression --message="Updating nginx web server configuration..."
+ynh_script_progression --message="Updating NGINX web server configuration..."
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
-# Change the path in the nginx config file
+# 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
+    # Make a backup of the original NGINX config file if modified
     ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
     # Replace locations starting with old_path
     # Look for every location possible patterns (see https://nginx.org/en/docs/http/ngx_http_core_module.html#location)
@@ -91,7 +91,7 @@ then
     ynh_store_file_checksum --file="$nginx_conf_path"
 fi
 
-# Change the domain for nginx
+# Change the domain for NGINX
 if [ $change_domain -eq 1 ]
 then
     # Delete file checksum for the old conf file location
@@ -110,7 +110,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..."
+ynh_script_progression --message="Reloading NGINX web server..."
 
 ynh_systemd_action --service_name=nginx --action=reload
 

scripts/install

@@ -82,9 +82,9 @@ ynh_setup_source --dest_dir="$final_path"
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring nginx web server..."
+ynh_script_progression --message="Configuring NGINX web server..."
 
-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config
 
 #=================================================
@@ -98,9 +98,9 @@ ynh_system_user_create --username=$app
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring php-fpm..."
+ynh_script_progression --message="Configuring PHP-FPM..."
 
-# Create a dedicated php-fpm config
+# Create a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=low --footprint=low --package="$extra_php_dependencies"
 phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
@@ -119,15 +119,27 @@ ynh_exec_warn_less ynh_install_composer --phpversion="$phpversion" --workdir="$f
 ynh_script_progression --message="Modifying a config file..."
 
 config="$final_path/.env"
-cp ../conf/.env "$config"
+cp -f ../conf/.env "$config"
 
-ynh_replace_string --match_string="random_key" --replace_string="$random_key" --target_file="$config"
+ynh_replace_string --match_string="SomeRandomStringOf32CharsExactly" --replace_string="$random_key" --target_file="$config"
-ynh_replace_string --match_string="yunouser" --replace_string="$db_name" --target_file="$config"
+ynh_replace_string --match_string="fireflyiiidb" --replace_string="127.0.0.1" --target_file="$config"
-ynh_replace_string --match_string="yunopass" --replace_string="$db_pwd" --target_file="$config"
+ynh_replace_string --match_string="DB_DATABASE=firefly" --replace_string="DB_DATABASE=$db_name" --target_file="$config"
-ynh_replace_string --match_string="yunobase" --replace_string="$db_name" --target_file="$config"
+ynh_replace_string --match_string="DB_USERNAME=firefly" --replace_string="DB_USERNAME=$db_name" --target_file="$config"
-ynh_replace_string --match_string="yunomail" --replace_string="$email" --target_file="$config"
+ynh_replace_string --match_string="secret_firefly_password" --replace_string="$db_pwd" --target_file="$config"
-ynh_replace_string --match_string="yunodomain" --replace_string="$domain" --target_file="$config"
+ynh_replace_string --match_string="MAIL_MAILER=log" --replace_string="MAIL_MAILER=smtp" --target_file="$config"
-ynh_replace_string --match_string="yunoappurl" --replace_string="$domain$path_url" --target_file="$config"
+ynh_replace_string --match_string="MAIL_HOST=null" --replace_string="MAIL_HOST=127.0.0.1" --target_file="$config"
+ynh_replace_string --match_string="MAIL_PORT=2525" --replace_string="MAIL_PORT=25" --target_file="$config"
+ynh_replace_string --match_string="mail@example.com" --replace_string="$email" --target_file="$config"
+ynh_replace_string --match_string="changeme@example.com" --replace_string="$app@$domain" --target_file="$config"
+# These helpers are for reference to impliment remove them once app gets support for LDAP. Put them directly in .env
+
+# ynh_replace_string --match_string="ADLDAP_CONTROLLERS=" --replace_string="ADLDAP_CONTROLLERS=127.0.0.1" --target_file="$config"
+# ynh_replace_string --match_string='ADLDAP_BASEDN=""' --replace_string='ADLDAP_BASEDN="dc=yunohost,dc=org"' --target_file="$config"
+# ynh_replace_string --match_string="ADLDAP_ACCOUNT_PREFIX=" --replace_string='ADLDAP_ACCOUNT_PREFIX="uid="' --target_file="$config"
+# ynh_replace_string --match_string="ADLDAP_ACCOUNT_SUFFIX=" --replace_string='ADLDAP_ACCOUNT_SUFFIX=",dc=yunohost,dc=org"' --target_file="$config"
+# ynh_replace_string --match_string="distinguishedname" --replace_string="uid" --target_file="$config"
+# ynh_replace_string --match_string="userprincipalname" --replace_string="uid" --target_file="$config"
+ynh_replace_string --match_string="localhost" --replace_string="$domain$path_url" --target_file="$config"
 
 #=================================================
 # STORE THE CONFIG FILE CHECKSUM
@@ -172,11 +184,6 @@ ynh_use_logrotate
 #=================================================
 ynh_script_progression --message="Configuring SSOwat..."
 
-if [ $is_public -eq 0 ]
-then	# Remove the public access
-    ynh_app_setting_delete --app=$app --key=skipped_uris
-fi
-
 # Make app public if necessary
 if [ $is_public -eq 1 ]
 then
@@ -187,7 +194,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..."
+ynh_script_progression --message="Reloading NGINX web server..."
 
 ynh_systemd_action --service_name=nginx --action=reload
 

scripts/remove

@@ -50,17 +50,17 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing nginx web server configuration..."
+ynh_script_progression --message="Removing NGINX web server configuration..."
 
-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing php-fpm configuration..."
+ynh_script_progression --message="Removing PHP-FPM configuration..."
 
-# Remove the dedicated php-fpm config
+# Remove the dedicated PHP-FPM config
 ynh_remove_fpm_config
 
 #=================================================

scripts/restore

@@ -46,7 +46,7 @@ test ! -d $final_path \
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring the nginx configuration..."
+ynh_script_progression --message="Restoring the NGINX configuration..."
 
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
@@ -80,7 +80,7 @@ ynh_script_progression --message="Restoring PHP-FPM configuration..."
 
 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 
-# Recreate a dedicated php-fpm config
+# Recreate a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=low --footprint=low --package="$extra_php_dependencies"
 
 #=================================================
@@ -114,7 +114,7 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app"
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
-ynh_script_progression --message="Reloading nginx web server and php-fpm..."
+ynh_script_progression --message="Reloading NGINX web server and PHP-FPM.."
 
 ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
 ynh_systemd_action --service_name=nginx --action=reload

scripts/upgrade

@@ -100,8 +100,10 @@ then
 	mkdir -p "$final_path/storage/upload/"
 	mkdir -p "$final_path/storage/export/"
 	cp -a "$final_path/storage/upload/" "$tmpdir/storage/upload/"
+	cp -a "$final_path/.env" "$tmpdir/.env"
 	cp -a "$final_path/storage/export/" "$tmpdir/storage/export/"
-	ynh_secure_remove "$final_path"
+	ynh_secure_remove --file="$final_path"
+
 
 	# Download, check integrity, uncompress and patch the source from app.src
 	ynh_setup_source --dest_dir="$final_path"
@@ -109,18 +111,19 @@ then
 	# Restore the config file
 	cp -a "$tmpdir/storage/upload/" "$final_path/storage/upload/"
 	cp -a "$tmpdir/storage/export/"  "$final_path/storage/export/"
-
+	cp -a  "$tmpdir/.env" "$final_path/.env"
 	# Remove temporary directory
-	ynh_secure_remove "$tmpdir"
+	ynh_secure_remove --file="$tmpdir"
+
 
 fi
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Upgrading nginx web server configuration..."
+ynh_script_progression --message="Upgrading NGINX web server configuration..."
 
-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config
 
 #=================================================
@@ -141,7 +144,7 @@ ynh_system_user_create --username=$app
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Upgrading php-fpm configuration..."
+ynh_script_progression --message="Upgrading PHP-FPM configuration..."
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config --usage=low --footprint=low --package="$extra_php_dependencies"
@@ -152,7 +155,7 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 # UPDATE PHP DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Updating php dependencies..."
+ynh_script_progression --message="Updating PHP dependencies..."
 
 chown -R "$app": "$final_path"
 
@@ -167,13 +170,26 @@ config="$final_path/.env"
 ynh_backup_if_checksum_is_different --file="$config"
 cp ../conf/.env "$config"
 
-ynh_replace_string --match_string="random_key" --replace_string="$random_key" --target_file="$config"
+ynh_replace_string --match_string="SomeRandomStringOf32CharsExactly" --replace_string="$random_key" --target_file="$config"
-ynh_replace_string --match_string="yunouser" --replace_string="$db_name" --target_file="$config"
+ynh_replace_string --match_string="fireflyiiidb" --replace_string="127.0.0.1" --target_file="$config"
-ynh_replace_string --match_string="yunopass" --replace_string="$db_pwd" --target_file="$config"
+ynh_replace_string --match_string="DB_DATABASE=firefly" --replace_string="DB_DATABASE=$db_name" --target_file="$config"
-ynh_replace_string --match_string="yunobase" --replace_string="$db_name" --target_file="$config"
+ynh_replace_string --match_string="DB_USERNAME=firefly" --replace_string="DB_USERNAME=$db_name" --target_file="$config"
-ynh_replace_string --match_string="yunomail" --replace_string="$email" --target_file="$config"
+ynh_replace_string --match_string="secret_firefly_password" --replace_string="$db_pwd" --target_file="$config"
-ynh_replace_string --match_string="yunodomain" --replace_string="$domain" --target_file="$config"
+ynh_replace_string --match_string="MAIL_MAILER=log" --replace_string="MAIL_MAILER=smtp" --target_file="$config"
-ynh_replace_string --match_string="yunoappurl" --replace_string="$domain$path_url" --target_file="$config"
+ynh_replace_string --match_string="MAIL_HOST=null" --replace_string="MAIL_HOST=127.0.0.1" --target_file="$config"
+ynh_replace_string --match_string="MAIL_PORT=2525" --replace_string="MAIL_PORT=25" --target_file="$config"
+ynh_replace_string --match_string="mail@example.com" --replace_string="$email" --target_file="$config"
+ynh_replace_string --match_string="changeme@example.com" --replace_string="$app@$domain" --target_file="$config"
+# These helpers are for reference.Remove them once app gets support for LDAP. Put them directly in .env
+
+# ynh_replace_string --match_string="ADLDAP_CONTROLLERS=" --replace_string="ADLDAP_CONTROLLERS=127.0.0.1" --target_file="$config"
+# ynh_replace_string --match_string='ADLDAP_BASEDN=""' --replace_string='ADLDAP_BASEDN="dc=yunohost,dc=org"' --target_file="$config"
+# ynh_replace_string --match_string="ADLDAP_ACCOUNT_PREFIX=" --replace_string='ADLDAP_ACCOUNT_PREFIX="uid="' --target_file="$config"
+# ynh_replace_string --match_string="ADLDAP_ACCOUNT_SUFFIX=" --replace_string='ADLDAP_ACCOUNT_SUFFIX=",dc=yunohost,dc=org"' --target_file="$config"
+# ynh_replace_string --match_string="distinguishedname" --replace_string="uid" --target_file="$config"
+# ynh_replace_string --match_string="userprincipalname" --replace_string="uid" --target_file="$config"
+ynh_replace_string --match_string="localhost" --replace_string="$domain$path_url" --target_file="$config"
+
 
 # Recalculate and store the checksum of the file for the next upgrade.
 ynh_store_file_checksum --file="$config"
@@ -184,9 +200,11 @@ ynh_store_file_checksum --file="$config"
 ynh_script_progression --message="Deploying..."
 
 pushd "$final_path"
+
 	php$phpversion artisan migrate:refresh --seed
 	php$phpversion artisan firefly-iii:upgrade-database
 	php$phpversion artisan passport:install
+	php$phpversion artisan cache:clear
 
 	#rm -rf "$final_path/bootstrap/cache/*"
 
@@ -231,7 +249,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..."
+ynh_script_progression --message="Reloading NGINX web server..."
 
 ynh_systemd_action --service_name=nginx --action=reload