natto1784/aslichan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Save Tinyboard docs (2012-10-16) from web.archive.org

Browse Source
This commit is contained in:
Amsemy Teladi
2019-04-18 16:15:46 +07:00
committed by Fredrick Brennan
parent 997326af59
commit a99c45de22
37 changed files with 690 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/config.md Normal file
View File

@@ -0,0 +1,34 @@
Configuration Basics
====================
It’s important that you read this page and don’t just assume it’s okay to make changes to [`inc/config.php`](../inc/config.php); it’s not. [`inc/config.php`](../inc/config.php) is used only to hold default values. It’s updated very frequently, so placing your local configuration there would make upgrading a very complicated process.
Instead, edit [`inc/instance-config.php`](../inc/instance-config.php).
Config files
------------
Tinyboard is made up of multiple configuration files:
* [`inc/config.php`](../inc/config.php) — These are the defaults. Do not edit this file or you will have a very hard time upgrading in the future.
* [`inc/instance-config.php`](../inc/instance-config.php) — Make all your site-wide changes here. This file is generated upon installation.
* `<board>/config.php` — Optional board-specific configuration files can also be made. These files don’t exist by default.
The syntax for [`inc/instance-config.php`](../inc/instance-config.php) and `<board>/config.php` is exactly the same to that of [`inc/config.php`](../inc/config.php). You can copy lines from `config.php` and place them in either one of these config files. That is what `config.php` is for.
The configuration variable (`$config`) is just one huge associative array, occasionally split into “sections”.
Loading order
-------------
It’s important to understand how the configuration files work to get the most out of Tinyboard.
* [`inc/config.php`](../inc/config.php) — `$config` is reset with the defaults.
* [`inc/instance-config.php`](../inc/instance-config.php) — Some `$config` values are overwritten or changed.
* `<board>/config.php` — If it exists, some more `$config` values are overwritten.
Comments
--------
The comments in [`inc/config.php`](../inc/config.php) are probably the greatest source of documentation. It is filled with descriptions for specific config variables as well as examples, for you to copy into [`inc/instance-config.php`](../inc/instance-config.php) and modify.
See also
--------
* [“Events”](events.md)
* [Custom flood filters](config/flood_filters.md)
* [Cache](config.md)