From e5751517b1e3d35d4d326e249114df8ac9acb01a Mon Sep 17 00:00:00 2001 From: Guillaume Mazoyer Date: Thu, 25 Sep 2014 21:44:48 +0200 Subject: Start documentation for the configuration options. --- docs/configuration.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/configuration.md (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..cbb77d2 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,29 @@ +# Looking Glass: Configuration Options + +## Format + +The *config.php* file is a piece of regular PHP source code. This means you +need to follow the rules or the interface will work. + +You can mostly get by copying the example lines, just make sure all your +strings are quoted and your statements end in a semicolon (;). + +All the default values for the configuration are defined in the +*includes/config.defaults.php* file. This file *must* not be edited. The +directives set in *config.php* will automatically override the default ones. + +## Directives + +These are the available configuration options. They can be set in *config.php*. + +### Frontpage + +### Routers + +### Logs + +### Filters + +### Misc. + +### Documentation -- cgit v1.2.3