Skip to content

Commit 48b110c

Browse files
committed
Improve configuration documentation, update based on new configuration file format
1 parent cbb2acc commit 48b110c

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

Docs/src/content/docs/guides/config.mdoc

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,13 @@ This is the name of the project, used across the codebase wherever the project n
1919

2020
#### Domain
2121

22-
The domain that the site will be primarily hosted from, without the URL scheme. For example, if the site is hosted at `https://example.com`, then this should be set to `example.com`. This is used in various places across the codebase where the domain needs to be referenced, including in constructing Client scripts & emails and substituting parts of existing URLs in XML-based assets.
22+
The domain that the Site will be primarily hosted from, without the URL scheme. For example, if the Site is hosted at `https://example.com`, then this should be set to `example.com`. This is used in various places across the codebase where the domain needs to be referenced, including in constructing Client scripts & emails and substituting parts of existing URLs in XML-based assets.
2323

24-
#### DatabaseDomain
24+
#### DomainInsecure
2525

26-
The domain name of the database server, without the URL scheme. This is used when setting up the Site's database connection. This domain is not accessed securely by default, so it's recommended to keep it on a local network or on the same machine as the Site. Make sure to include the port if necessary.
26+
The domain that the Site will be hosted on when accessed insecurely, without the URL scheme. This is used for requests that do not or cannot support HTTPS. By default, this is the Domain property with a `www.` subdomain added.
27+
28+
This domain should not be used to access the Site. More information is given in the [Client TLS](/design/client-tls) section of the documentation.
2729

2830
#### RCCServiceProxyURL
2931

@@ -51,4 +53,22 @@ The symbol to use when displaying currency values across the site. This is used
5153

5254
An array that contains the optional pages for the site, with a string value for each name: Statistics, Groups, and Forum. If a page is removed from this array, it will not be accessible on the site, returning a 404 Not Found error, and any links to it will be removed from the UI.
5355

56+
### Database
57+
58+
#### Database – AutoStart
59+
60+
Whether to automatically start the database server when starting the Site. Requires that [SurrealDB](/install/surrealdb) is installed and available on the command line or in your system's PATH as `surreal`.
61+
62+
This is recommended to be enabled in all cases except when debugging database issues, or when managing the database server separately from the Site, surch as when using a container manager.
63+
64+
#### Database – Domain
65+
66+
The domain name of the database server, without the URL scheme. This is used when setting up the Site's database connection. This domain is not accessed securely by default, so it's recommended to keep it on a local network or on the same machine as the Site. Make sure to include the port if necessary.
67+
68+
### Economy
69+
70+
#### Economy – AutoStart
71+
72+
Whether to automatically start the Economy service when starting the Site. This is recommended to be enabled in all cases except when debugging Economy service issues, or when managing the Economy service separately from the Site, such as when using a container manager.
73+
5474
### todo

0 commit comments

Comments
 (0)