writefreely/docs
2
0
Fork 0
mirror of https://github.com/writefreely/documentation.git synced 2024-11-14 23:11:03 +00:00
Code Issues Releases Wiki Activity

Add app, database, and server options added since 0.12

Browse Source
This commit is contained in:
Matt Baer 2021-05-10 16:46:45 -04:00
parent 85c337fa6e
commit df23fb6d77
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
admin/config.md
View File

@ -17,6 +17,7 @@ The following fields are valid in the `[server]` section of your configuration f
| `tls_cert_path` | TLS certificate path. If supplied with `tls_key_path`, requests will be served on port 443. If `autocert` is `true`, certificates and keys will be stored in the given directory. | _None_ | | `tls_cert_path` | TLS certificate path. If supplied with `tls_key_path`, requests will be served on port 443. If `autocert` is `true`, certificates and keys will be stored in the given directory. | _None_ |
| `tls_key_path` | TLS private key path. If supplied with `tls_cert_path`, requests will be served on port 443. | _None_ | | `tls_key_path` | TLS private key path. If supplied with `tls_cert_path`, requests will be served on port 443. | _None_ |
| `autocert` | Enable automatic certificate generation with Let's Encrypt. Requires `tls_cert_path` and `tls_key_path` to not be empty, and running in standalone server mode, i.e. `port` set to `443`. | `false` | | `autocert` | Enable automatic certificate generation with Let's Encrypt. Requires `tls_cert_path` and `tls_key_path` to not be empty, and running in standalone server mode, i.e. `port` set to `443`. | `false` |
| `gopher_port` | Port to run Gopher server on. If this is `0`, Gopher access will be disabled. | 0 |
| `templates_parent_dir` | The parent directory containing the `templates` directory | _(current directory)_ | | `templates_parent_dir` | The parent directory containing the `templates` directory | _(current directory)_ |
| `static_parent_dir` | The parent directory containing the `static` directory | _(current directory)_ | | `static_parent_dir` | The parent directory containing the `static` directory | _(current directory)_ |
| `pages_parent_dir` | The parent directory containing the `pages` directory | _(current directory)_ | | `pages_parent_dir` | The parent directory containing the `pages` directory | _(current directory)_ |
@ -39,6 +40,7 @@ These fields only apply to instances using **MySQL**.
| `database` | Database name | _None_ | | `database` | Database name | _None_ |
| `host` | Database hostname to connect to | localhost | | `host` | Database hostname to connect to | localhost |
| `port` | Database host port to connect to | 3306 | | `port` | Database host port to connect to | 3306 |
| `tls` | Whether or not to use TLS to connect to database | false |
These fields only apply to instances using **SQLite**. These fields only apply to instances using **SQLite**.
@ -58,7 +60,9 @@ The following fields are valid in the `[app]` section of your configuration file
| `single_user` | Whether or not the instance is for one blog | false | | `single_user` | Whether or not the instance is for one blog | false |
| `min_username_len` | Minimum required length of usernames | 3 | | `min_username_len` | Minimum required length of usernames | 3 |
| `federation` | Whether or not federation via ActivityPub is enabled | true | | `federation` | Whether or not federation via ActivityPub is enabled | true |
| `notes_only` | By default, WriteFreely federates posts as [`Article`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-article)s and [`Note`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-note)s. This only sends them as `Note`s. | false |
| `public_stats` | Whether or not usage stats are made public via NodeInfo | true | | `public_stats` | Whether or not usage stats are made public via NodeInfo | true |
| `monetization` | Enables monetization options for users (currently, only [Web Monetization](http://webmonetization.org/)) | true |
| `disable_password_auth` | Whether or not new users can sign up via the landing page. Useful if you want to limit new users to your OAuth provider. | false | | `disable_password_auth` | Whether or not new users can sign up via the landing page. Useful if you want to limit new users to your OAuth provider. | false |
These fields can always be set, but only apply to **multi-user** instances. These fields can always be set, but only apply to **multi-user** instances.
@ -68,6 +72,7 @@ These fields can always be set, but only apply to **multi-user** instances.
| `private` | When enabled, all blogs and posts will only be readable by other authenticated users on the instance. | false | | `private` | When enabled, all blogs and posts will only be readable by other authenticated users on the instance. | false |
| `landing` | The default landing route for an unauthenticated user | /login | | `landing` | The default landing route for an unauthenticated user | /login |
| `open_registration` | Whether or not anyone can register via the landing page | true | | `open_registration` | Whether or not anyone can register via the landing page | true |
| `open_deletion` | Whether or not users can delete their account on their own (via web UI) | true |
| `max_blogs` | Maximum number of blogs a single user can create under one account | 5 | | `max_blogs` | Maximum number of blogs a single user can create under one account | 5 |
| `local_timeline` | Whether or not the instance reader (and the _Public_ option on blogs) is enabled | true | | `local_timeline` | Whether or not the instance reader (and the _Public_ option on blogs) is enabled | true |
| `user_invites` | Who is allowed to send user invites, if anyone. A blank value disables invites for all users. Valid choices: _empty_, `user`, or `admin` | user | | `user_invites` | Who is allowed to send user invites, if anyone. A blank value disables invites for all users. Valid choices: _empty_, `user`, or `admin` | user |