From d9d9394c97c9e8ba1bf9bafb54cf6c7f3e65d4eb Mon Sep 17 00:00:00 2001 From: "J. King" Date: Tue, 30 Jul 2019 13:29:54 -0400 Subject: [PATCH] Information on the configuration file --- .../030_Web_Server_Configuration.md | 2 +- docs/en/020_Getting_Started/050_Configuration.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/en/020_Getting_Started/030_Web_Server_Configuration.md b/docs/en/020_Getting_Started/030_Web_Server_Configuration.md index 2a79f5b..578fdad 100644 --- a/docs/en/020_Getting_Started/030_Web_Server_Configuration.md +++ b/docs/en/020_Getting_Started/030_Web_Server_Configuration.md @@ -6,7 +6,7 @@ As a PHP application, The Arsse requires the aid of a Web server in order to com Samples included here only cover the bare minimum for configuring a virtual host. In particular, configuration for HTTPS (which is highly recommended) is omitted for the sake of clarity -## Configuration for Nginx +# Configuration for Nginx ```nginx server { diff --git a/docs/en/020_Getting_Started/050_Configuration.md b/docs/en/020_Getting_Started/050_Configuration.md index 29e216d..08a3749 100644 --- a/docs/en/020_Getting_Started/050_Configuration.md +++ b/docs/en/020_Getting_Started/050_Configuration.md @@ -1,5 +1,19 @@ # The Configuration File +The Arsse looks for configuration in a file named `config.php` in the directory where it is installed. For example, if The Arsse is installed at `/usr/share/arsse`, it will look for configuration in the file `/usr/share/arsse/config.php`. It is not an error for this file not to exist or to be empty: The Arsse will function with no configuration whatsoever, provided other conditions allow. + +The configuration file is a PHP script which returns an associative array with keys and values for one or more settings. Any settings which are not specified in the configuration file will be set to its default. Invalid values will cause an error on start-up; unknown keys are ignored. A basic configuration file might look like this: + +```php + "en", + 'dbDriver' => "sqlite3", + 'dbSQLite3File' => "/var/lib/arsse/arsse.db", +]; +``` + +The `config.defaults.php` file included with copies of The Arsse contains an annotated listing of every configuration setting with its default value. The settings are also documented in more detail below. + # List of All Settings ## General settings