mirror/Arsse
1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 21:22:40 +00:00
Code Issues Activity

Information on the configuration file

Browse source
This commit is contained in:
J. King 2019-07-30 13:29:54 -04:00
parent 5402a1688b
commit d9d9394c97
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/en/020_Getting_Started/030_Web_Server_Configuration.md
View file

@ -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 {

14
docs/en/020_Getting_Started/050_Configuration.md
View file

@ -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
<?php return [
'lang' => "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