Updated Server Configuration (markdown)

master
Noah Petherbridge 6 years ago
parent
commit
0afe26b5f6
  1. 17
      Server-Configuration.md

17
Server-Configuration.md

@ -1,9 +1,20 @@
# Config File
Copy the file `config-sample.py` as a file named `config.py`, and edit its contents to set up your site. It's very important that you change the `SECRET_KEY` variable, as this is used to sign the session cookies and
prevent people from tampering with them. The config script is well-documented with comments explaining what all the options do.
Rophako uses the YamlSettings module for its configuration. There is a default settings file named `defaults.yml`; use it for reference to see what options are available.
See [Apache](#apache-configurations) and [nginx](#nginx-configurations) configurations.
To configure your site, create a file named `settings.yml` and define the keys/values that you want to *override* from the defaults. For example, if the only thing you want to change is the site's name and secret key, the `settings.yml` can look as simple as this:
```yaml
rophako:
site:
site_name: new-site.com
security:
secret_key: helloworld123456
```
The default config is loaded by the app first and then your custom settings are masked on top, so you only need to include the settings you want to change in the settings.yml. The defaults file is thoroughly commented, so check it out.
For the web server side of things, see [Apache](#apache-configurations) and [nginx](#nginx-configurations) configurations.
# Apache Configurations

Loading…
Cancel
Save