From d7faf3ac2908fb463068226d353e9a5a15af7caa Mon Sep 17 00:00:00 2001 From: Miraty Date: Fri, 19 May 2023 00:54:04 +0200 Subject: [PATCH] Rename config.ini to config.template.ini --- .gitignore | 1 + DOCS/configuration.md | 2 +- DOCS/installation.md | 6 +++++- DOCS/translation.md | 4 ++-- config.ini => config.template.ini | 0 5 files changed, 9 insertions(+), 4 deletions(-) rename config.ini => config.template.ini (100%) diff --git a/.gitignore b/.gitignore index 2dd6120..1763d49 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +/config.ini /db/servnest.db /locales/*/C/LC_MESSAGES/messages.mo diff --git a/DOCS/configuration.md b/DOCS/configuration.md index 7dacf81..0ff0f40 100644 --- a/DOCS/configuration.md +++ b/DOCS/configuration.md @@ -1,6 +1,6 @@ # Configuration reference -This document describes the `config.ini` directives. It's an INI file, parsed by [PHP's `parse_ini_file`](https://www.php.net/manual/function.parse-ini-file.php). Every setting is expected to be present. +This document describes the ServNest configuration directives that are part of `config.ini` (distributed as `config.template.ini`). It's an INI file, parsed by [PHP's `parse_ini_file` function](https://www.php.net/manual/function.parse-ini-file.php). Every directive is expected to be present. ## `[common]` diff --git a/DOCS/installation.md b/DOCS/installation.md index 4f74d3e..e7e9a42 100644 --- a/DOCS/installation.md +++ b/DOCS/installation.md @@ -293,4 +293,8 @@ echo sftp.servnest.test. 86400 SSHFP 4 2 $(cut -d ' ' -f 2 /etc/sftpgo/ed25519.p ### ServNest core configuration -Configure `/srv/servnest/core/config.ini` according to [the ServNest configuration reference](configuration.md). +Copy the configuration template to the actual configuration file and adapt it according to [the ServNest configuration reference](configuration.md): +```shell +cp /srv/servnest/core/config.template.ini /srv/servnest/core/config.ini +vim /srv/servnest/core/config.ini +``` diff --git a/DOCS/translation.md b/DOCS/translation.md index 05420e2..de9146d 100644 --- a/DOCS/translation.md +++ b/DOCS/translation.md @@ -1,4 +1,4 @@ -# Translation with gettext +# Memo to work with gettext ## As a developer @@ -35,4 +35,4 @@ To compile Portable Objects into Machine Objects: msgfmt locales/fr/C/LC_MESSAGES/messages.po -o locales/fr/C/LC_MESSAGES/messages.mo ``` -Machine Objects files are kept in cache by the Gettext extension, so PHP-FPM needs to be restarted to update translations. +Machine Objects files are kept in cache by the PHP gettext extension, so PHP-FPM needs to be restarted to update translations. diff --git a/config.ini b/config.template.ini similarity index 100% rename from config.ini rename to config.template.ini