Переглянути джерело

Rename config.ini to config.template.ini

Miraty 2 роки тому
батько
коміт
d7faf3ac29
5 змінених файлів з 9 додано та 4 видалено
  1. 1 0
      .gitignore
  2. 1 1
      DOCS/configuration.md
  3. 5 1
      DOCS/installation.md
  4. 2 2
      DOCS/translation.md
  5. 0 0
      config.template.ini

+ 1 - 0
.gitignore

@@ -1,2 +1,3 @@
+/config.ini
 /db/servnest.db
 /locales/*/C/LC_MESSAGES/messages.mo

+ 1 - 1
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]`
 

+ 5 - 1
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
+```

+ 2 - 2
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.

+ 0 - 0
config.ini → config.template.ini