diff options
| author | Guillaume Mazoyer <respawneral@gmail.com> | 2014-09-25 21:44:48 +0200 |
|---|---|---|
| committer | Guillaume Mazoyer <respawneral@gmail.com> | 2014-09-25 21:44:48 +0200 |
| commit | e5751517b1e3d35d4d326e249114df8ac9acb01a (patch) | |
| tree | 88a08c8cee51da019695d7ad57e93f76e6180e5a /docs | |
| parent | 89e16b0c0202899486d4952cdd0017a1ebb7db9e (diff) | |
Start documentation for the configuration options.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.md | 29 | ||||
| -rw-r--r-- | docs/misc.md | 5 |
2 files changed, 29 insertions, 5 deletions
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 diff --git a/docs/misc.md b/docs/misc.md deleted file mode 100644 index 9c29361..0000000 --- a/docs/misc.md +++ /dev/null @@ -1,5 +0,0 @@ -# Looking Glass: Miscellaneous information - -## Topic 1 - -## Topic 2 |