threadr.lostcave.ddnss.de/config/README.md

23 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2021-09-02 02:40:53 +02:00
# Files
### [about.template](./about.template)
2021-09-08 10:41:43 +02:00
The customizable part of the about page, HTML code for now, will eventually be replaced with a markdown file
2021-09-02 15:47:01 +02:00
### [instance.conf](./instance.conf)
configuration for a specific instance
- domain_name=<public facing domain name of the instance>
2021-09-08 10:18:50 +02:00
- threadr_dir=<directory on the webhost\*>
2021-09-02 15:47:01 +02:00
- db_username=<mysql user>
- db_password=<mysql password>
2021-09-02 17:01:28 +02:00
- db_database=<name of the database>
- db_svr_host=<mysql server address>
2021-09-08 10:41:43 +02:00
\* ThreadR does not support an installation on the webroot directly. See installation instructions for how to work around that.
2021-09-02 17:01:28 +02:00
I know some of these option names are silly but they all have the same length. -BodgeMaster
2021-09-02 15:47:01 +02:00
The format is strictly `<option>=<value>` because the mechanism used to load the config values is very simple. Dont add additional whitespace for fancy formatting. Things *will* break. You have been warned.
2021-09-02 15:47:01 +02:00
The config is loaded once on deployment by the "variable grabbler" macro processor with `["exec","echo -n \"$(sed --quiet \"/<option>=/s/.*=//p\" config/instance.conf)\""]`.
2021-09-02 02:40:53 +02:00
### [README.md](./README.md)
this file