gosora/docs/configuration.md

# Configuration

For configuring the system, Gosora has a file called `config/config.json` which you can tweak to change various behaviours, it also has a few settings in the Setting Manager in the Control Panel.

The configuration file has five categories you may be familiar with from poring through it's contents. Site, Config, Database, Dev and Plugin.

Site is for critical settings.

Config is for lower priority yet still important settings.

Database contains the credentials for the database (you will be able to pass these via parameters to the binary in a future version).

Dev is for a few flags which help out with the development of Gosora.

Plugin which you may not have run into is a category in which plugins can define their own custom configuration settings.

An example of what the file might look like: https://github.com/Azareal/Gosora/blob/master/config/config_example.json

# Site

ShortName - A two or three letter abbreviation of your site's name. Intended for compact spaces where the full name is too long to squeeze in.

Name - The name of your site, as appears in the title, some theme headers and search engine search results.

Email - The email address you want to show up in the From: field when Gosora sends emails. May be left blank, if emails are disabled.

URL - The URL for your site. Please leave out the `http://` or `https://` and the `/` at the end.

Port - The port you want Gosora to listen on. This will usually be 443 for HTTPS and 80 for HTTP. Gosora will try to bind to both, if you're on HTTPS to redirect users from the HTTP site to the HTTPS one.

EnableSsl - Determines whether HTTPS is enabled.

EnableEmails - Determines whether the SMTP mail subsystem is enabled. The experimental plugin sendmail also allows you to send emails without SMTP in a similar style to some languages like PHP, although it only works on Linux and has some issues.

HasProxy - Brittle, but lets you set whether you're sitting behind a proxy like Cloudflare. Unknown effects with reverse-proxies like Nginx.

Language - The language you want to use. Defaults to english. Please consult [internationalisation](https://github.com/Azareal/Gosora/blob/master/docs/internationalisation.md) for details.

# Config

SslPrivkey - The path to the SSL private key. Example: ./cert/test.key

SslFullchain - The path to the fullchain SSL certificate. Example: ./cert/test.cert

SMTPServer - The domain for the SMTP server. May be left blank if EnableEmails is false.

SMTPUsername - The username for the SMTP server.

SMTPPassword - The password for the SMTP server.

SMTPPort - The port for the SMTP server, usually 25 or 465 for full TLS.

SMTPEnableTLS - Enable TLS to fully encrypt the connection between Gosora and the SMTP server.

Search - The type of search system to use. Options: disabled, sql (default)

MaxRequestSizeStr - The maximum size that a request made to Gosora can be. This includes uploads. Example: 5MB

UserCache - The type of user cache you want to use. You can leave this blank to disable this feature or use `static` for a small in-memory cache.

TopicCache - The type of topic cache you want to use. You can leave this blank to disable this feature or use `static` for a small in-memory cache.

UserCacheCapacity - The maximum number of users you want in the in-memory user cache, if enabled in the UserCache setting.

TopicCacheCapacity - The maximum number of topics you want in the in-memory topic cache, if enabled in the TopicCache setting.

DefaultPath - The route you want the homepage `/` to default to. Examples: `/topics/` or `/forums/`

DefaultGroup - The group you want users to be moved to once they're activated. Example: 3

ActivationGroup - The group you want users to be placed in while they're awaiting activation. Example: 5

StaffCSS - Classes you want applied to the postbits for staff posts. This setting is deprecated and will likely be replaced with a more generic mechanism in the near future.

DefaultForum - The default forum for the drop-down in the quick topic creator. Please note that FID 1 is reserved for the default reports forum. Example: 2

MinifyTemplates - Whether you want the HTML pages to be minified prior to being send to the client.

BuildSlugs - Whether you want the title appear in the URL. For instance: `/topic/traffic-in-paris.5` versus `/topic/5`

ServerCount - The number of instances you're running. This setting is currently experimental.

PostIPCutoff - The number of days which need to pass before the IP data for a post is automatically deleted. 0 defaults to whatever the current default is, currently 180 and -1 disables this feature. Default: 0

DisableLiveTopicList - This switch allows you to disable the live topic list. Default: false

DisableJSAntispam - This switch lets you disable the JS anti-spam feature. It may be useful if you primarily get users who for one reason or another have decided to disable JavaScript. Default: false

LooseHost - Disable host header checks in the router. May be useful when using a reverse-proxy like Nginx. Default: false

LoosePort - Disable port match checks in the router. May be useful when using a revere-proxy like Nginx. Default: false

DisableServerPush - This switch lets you disable the HTTP/2 server push feature. Default: false

EnableCDNPush - This switch lets you enable the HTTP/2 CDN Server Push feature. This operates by sending a Link header on every request and may also work with reverse-proxies like Nginx for doing HTTP/2 server pushes.

DisableNoavatarRange - This switch lets you disable the noavatar algorithm which maps IDs to a set ranging from 0 to 50 for better cacheability. Default: false

DisableDefaultNoavatar - This switch lets you disable the default noavatar algorithm which may intercept noavatars for increased efficiency. Default: false

NoAvatar - The default avatar to use for users when they don't have their own. The default for this may change in the near future to better utilise HTTP/2. Example: https://api.adorable.io/avatars/{width}/{id}.png

ItemsPerPage - The number of posts, topics, etc. you want on each page.

MaxTopicTitleLength - The maximum length that a topic can be. Please note that this measures the number of bytes and may differ from language to language with it being equal to a letter in English and being two bytes in others.

MaxUsernameLength - The maximum length that a user's name can be. Please note that this measures the number of bytes and may differ from language to language with it being equal to a letter in English and being two bytes in others.

ReadTimeout - The number of seconds that we are allowed to take to fully read a request. Defaults to 8.

WriteTimeout - The number of seconds that a route is allowed to run for before the request is automatically terminated. Defaults to 10.

IdleTimeout - The number of seconds that a Keep-Alive connection will be kept open before being closed. You might to tweak this, if you use Cloudflare or similar. Defaults to 120.

Related: https://support.cloudflare.com/hc/en-us/articles/212794707-General-Best-Practices-for-Load-Balancing-at-your-origin-with-Cloudflare


# Database

Adapter - The name of the database adapter. `mysql` and `mssql` are options, although mssql may not work properly in the latest version of Gosora. PgSQL support is in the works.

Host - The host of the database you wish to connect to. Example: localhost

Username - The username for the database you wish to connect to. Example: root

Password - The password for the database you wish to connect to. Example: password

Dbname - The name of the database you want to use. Example: gosora

Port - The port the database is listening on. Usually 3306 for MySQL.

TestAdapter - A test version of Adapter. Only used for testing purposes.

TestHost - A test version of Host. Only used for testing purposes.

TestUsername - A test version of Username. Only used for testing purposes.

TestPassword - A test version of Password. Only used for testing purposes.

TestDbname - A test version of Dbname. Only used for testing purposes.

TestPort - A test version of Port. Only used for testing purposes.

# Dev

DebugMode - Outputs a basic level of information about what Gosora is doing to help ease debugging.

SuperDebug - Outputs a detailed level of information about what Gosora is doing to help ease debugging. Warning: This may cause severe slowdowns in Gosora.

TemplateDebug - Output a detailed level of information about what Gosora is doing during the template transpilation step. Warning: Large amounts of information will be dumped into the logs.

NoFsnotify - Whether you want to disable the file watcher which automatically reloads assets whenever they change.
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00			`# Configuration`

			For configuring the system, Gosora has a file called `config/config.json` which you can tweak to change various behaviours, it also has a few settings in the Setting Manager in the Control Panel.

Added the Plugin section to config.json Added support for ZIP files to the backups route. The post counter won't be incremented if json marshalling fails now. Added the router_pre_route hook. Added the router_end hook. Added the action_end_create_topic hook. Added the action_end_create_reply hook. 2019-04-06 01:08:49 +00:00			`The configuration file has five categories you may be familiar with from poring through it's contents. Site, Config, Database, Dev and Plugin.`
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00
Added the Plugin section to config.json Added support for ZIP files to the backups route. The post counter won't be incremented if json marshalling fails now. Added the router_pre_route hook. Added the router_end hook. Added the action_end_create_topic hook. Added the action_end_create_reply hook. 2019-04-06 01:08:49 +00:00			`Site is for critical settings.`

			`Config is for lower priority yet still important settings.`

			`Database contains the credentials for the database (you will be able to pass these via parameters to the binary in a future version).`

			`Dev is for a few flags which help out with the development of Gosora.`

			`Plugin which you may not have run into is a category in which plugins can define their own custom configuration settings.`
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00
			`An example of what the file might look like: https://github.com/Azareal/Gosora/blob/master/config/config_example.json`

			`# Site`

			`ShortName - A two or three letter abbreviation of your site's name. Intended for compact spaces where the full name is too long to squeeze in.`

			`Name - The name of your site, as appears in the title, some theme headers and search engine search results.`

Added information about the Email, DisableLiveTopicList, DisableJSAntispam, MaxTopicTitleLength and MaxUsernameLength configuration settings to configuration.md 2019-02-21 06:52:32 +00:00			`Email - The email address you want to show up in the From: field when Gosora sends emails. May be left blank, if emails are disabled.`

Added the configuration documentation file. 2019-02-20 05:35:18 +00:00			URL - The URL for your site. Please leave out the `http://` or `https://` and the `/` at the end.

The router now redirects requests to localhost domains with localhost equivalents in the host header which don't quite match the destination to the proper domain. The router now rejects host headers with the wrong port for non-standard ports. The www. redirect now handles non-standard ports properly. The Site.Port configuration setting is now validated on start-up to ensure it's a valid integer. Quickly fixed up the grammar of the Port block in configuration.md 2019-04-01 05:44:38 +00:00			`Port - The port you want Gosora to listen on. This will usually be 443 for HTTPS and 80 for HTTP. Gosora will try to bind to both, if you're on HTTPS to redirect users from the HTTP site to the HTTPS one.`
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00
			`EnableSsl - Determines whether HTTPS is enabled.`

			`EnableEmails - Determines whether the SMTP mail subsystem is enabled. The experimental plugin sendmail also allows you to send emails without SMTP in a similar style to some languages like PHP, although it only works on Linux and has some issues.`

			`HasProxy - Brittle, but lets you set whether you're sitting behind a proxy like Cloudflare. Unknown effects with reverse-proxies like Nginx.`

			`Language - The language you want to use. Defaults to english. Please consult [internationalisation](https://github.com/Azareal/Gosora/blob/master/docs/internationalisation.md) for details.`

			`# Config`

			`SslPrivkey - The path to the SSL private key. Example: ./cert/test.key`

			`SslFullchain - The path to the fullchain SSL certificate. Example: ./cert/test.cert`

			`SMTPServer - The domain for the SMTP server. May be left blank if EnableEmails is false.`

			`SMTPUsername - The username for the SMTP server.`

			`SMTPPassword - The password for the SMTP server.`

Activation tokens should work again now. Document the SMTPEnableTLS setting and update the documentation for SMTPPort. 2019-03-03 06:10:26 +00:00			`SMTPPort - The port for the SMTP server, usually 25 or 465 for full TLS.`

			`SMTPEnableTLS - Enable TLS to fully encrypt the connection between Gosora and the SMTP server.`
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00
You can now disable the search subsystem. Try Travis with MariaDB 12... 2019-02-23 06:55:34 +00:00			`Search - The type of search system to use. Options: disabled, sql (default)`

Added the configuration documentation file. 2019-02-20 05:35:18 +00:00			`MaxRequestSizeStr - The maximum size that a request made to Gosora can be. This includes uploads. Example: 5MB`

			UserCache - The type of user cache you want to use. You can leave this blank to disable this feature or use `static` for a small in-memory cache.

			TopicCache - The type of topic cache you want to use. You can leave this blank to disable this feature or use `static` for a small in-memory cache.

			`UserCacheCapacity - The maximum number of users you want in the in-memory user cache, if enabled in the UserCache setting.`

			`TopicCacheCapacity - The maximum number of topics you want in the in-memory topic cache, if enabled in the TopicCache setting.`

			DefaultPath - The route you want the homepage `/` to default to. Examples: `/topics/` or `/forums/`

			`DefaultGroup - The group you want users to be moved to once they're activated. Example: 3`

			`ActivationGroup - The group you want users to be placed in while they're awaiting activation. Example: 5`

			`StaffCSS - Classes you want applied to the postbits for staff posts. This setting is deprecated and will likely be replaced with a more generic mechanism in the near future.`

			`DefaultForum - The default forum for the drop-down in the quick topic creator. Please note that FID 1 is reserved for the default reports forum. Example: 2`

			`MinifyTemplates - Whether you want the HTML pages to be minified prior to being send to the client.`

			BuildSlugs - Whether you want the title appear in the URL. For instance: `/topic/traffic-in-paris.5` versus `/topic/5`

			`ServerCount - The number of instances you're running. This setting is currently experimental.`

Implemented periodic post IP purging for replies. Update for MySQL now supports DateCutoff and DateOlderThan. Added the DateOlderThan method to accUpdateBuilder. Added the PostIPCutoff config setting. 2019-05-08 09:50:10 +00:00			`PostIPCutoff - The number of days which need to pass before the IP data for a post is automatically deleted. 0 defaults to whatever the current default is, currently 180 and -1 disables this feature. Default: 0`

Added more default values to configuration.md 2019-04-14 23:39:13 +00:00			`DisableLiveTopicList - This switch allows you to disable the live topic list. Default: false`
Added information about the Email, DisableLiveTopicList, DisableJSAntispam, MaxTopicTitleLength and MaxUsernameLength configuration settings to configuration.md 2019-02-21 06:52:32 +00:00
Added more default values to configuration.md 2019-04-14 23:39:13 +00:00			`DisableJSAntispam - This switch lets you disable the JS anti-spam feature. It may be useful if you primarily get users who for one reason or another have decided to disable JavaScript. Default: false`
Added information about the Email, DisableLiveTopicList, DisableJSAntispam, MaxTopicTitleLength and MaxUsernameLength configuration settings to configuration.md 2019-02-21 06:52:32 +00:00
Added more default values to configuration.md 2019-04-14 23:39:13 +00:00			`LooseHost - Disable host header checks in the router. May be useful when using a reverse-proxy like Nginx. Default: false`
Added the LooseHost config setting. Malformed requests are now logged with an integer denoting the block of code which triggered it. 2019-04-14 00:13:32 +00:00
Added more default values to configuration.md 2019-04-14 23:39:13 +00:00			`LoosePort - Disable port match checks in the router. May be useful when using a revere-proxy like Nginx. Default: false`
Added the LoosePort config.json setting. 2019-04-14 00:28:42 +00:00
Added more default values to configuration.md 2019-04-14 23:39:13 +00:00			`DisableServerPush - This switch lets you disable the HTTP/2 server push feature. Default: false`
Server push is back. But only for Chrome and Firefox. Added the DisableServerPush and EnableCDNPush config.json settings. 2019-04-02 07:43:11 +00:00
			`EnableCDNPush - This switch lets you enable the HTTP/2 CDN Server Push feature. This operates by sending a Link header on every request and may also work with reverse-proxies like Nginx for doing HTTP/2 server pushes.`

The rest of the Control Panel (exc. the Group Editor) now uses dyntmpl. Improved the noavatar cacheability by constraining them in a range. Improved the noavatar cacheability by serving a small subset from Gosora. Improved the formatting of bytes in the memory analytics pane. Static resources with checksums will now have their caches expire in a week rather than a day. Tweaked the padding on the sub_heads on Nox. Moved a block of CSS out of a template and into panel.css in Tempra Simple and Shadow. Added the panel_themes_menus_items_suffix phrase. Added the DisableNoavatarRange config setting. Added the DisableDefaultNoavatar config setting. 2019-05-03 08:34:18 +00:00			`DisableNoavatarRange - This switch lets you disable the noavatar algorithm which maps IDs to a set ranging from 0 to 50 for better cacheability. Default: false`

			`DisableDefaultNoavatar - This switch lets you disable the default noavatar algorithm which may intercept noavatars for increased efficiency. Default: false`

Added the configuration documentation file. 2019-02-20 05:35:18 +00:00			`NoAvatar - The default avatar to use for users when they don't have their own. The default for this may change in the near future to better utilise HTTP/2. Example: https://api.adorable.io/avatars/{width}/{id}.png`

			`ItemsPerPage - The number of posts, topics, etc. you want on each page.`

Added information about the Email, DisableLiveTopicList, DisableJSAntispam, MaxTopicTitleLength and MaxUsernameLength configuration settings to configuration.md 2019-02-21 06:52:32 +00:00			`MaxTopicTitleLength - The maximum length that a topic can be. Please note that this measures the number of bytes and may differ from language to language with it being equal to a letter in English and being two bytes in others.`

			`MaxUsernameLength - The maximum length that a user's name can be. Please note that this measures the number of bytes and may differ from language to language with it being equal to a letter in English and being two bytes in others.`

Experimenting with Nox's Control Panel. Experimenting with better cache busting for static resources. HTTPSRedirect requests are now counted in the route analytics. More scripts are loaded asynchronously now. Upped the default ReadTimeout to eight seconds. Reduce the number of unneccesary NewAcc calls. Added panel_before_head as an injection point for themes. Themes can now declare scripts to be loaded asynchronously. Tweaked the WS resumption algorithm to mae the backoffs a little less aggressive. Fixed an ordering issue in the WS resumption algorithm where backoffs weren't expiring as fast as they should have. Fixed a bug where template logs weren't being written due to a panic. You can now use byte slices in more places in the transpiled templates. Fixed a bug where Cosora's misc.js seemed to be erroring out. Fixed a bug where YT embeds were getting blocked by the CSP. Added the panel_back_to_site phrase. Added the panel_welcome phrase. 2019-03-21 22:59:41 +00:00			`ReadTimeout - The number of seconds that we are allowed to take to fully read a request. Defaults to 8.`
Added documentation for server timeouts. You can now disable server timeouts o.O Added a slightly more sophisticated WS Backoff algorithm. 2019-03-16 23:14:47 +00:00
			`WriteTimeout - The number of seconds that a route is allowed to run for before the request is automatically terminated. Defaults to 10.`

			`IdleTimeout - The number of seconds that a Keep-Alive connection will be kept open before being closed. You might to tweak this, if you use Cloudflare or similar. Defaults to 120.`

			`Related: https://support.cloudflare.com/hc/en-us/articles/212794707-General-Best-Practices-for-Load-Balancing-at-your-origin-with-Cloudflare`

Added information about the Email, DisableLiveTopicList, DisableJSAntispam, MaxTopicTitleLength and MaxUsernameLength configuration settings to configuration.md 2019-02-21 06:52:32 +00:00
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00			`# Database`

			Adapter - The name of the database adapter. `mysql` and `mssql` are options, although mssql may not work properly in the latest version of Gosora. PgSQL support is in the works.

			`Host - The host of the database you wish to connect to. Example: localhost`

			`Username - The username for the database you wish to connect to. Example: root`

			`Password - The password for the database you wish to connect to. Example: password`

			`Dbname - The name of the database you want to use. Example: gosora`

			`Port - The port the database is listening on. Usually 3306 for MySQL.`

			`TestAdapter - A test version of Adapter. Only used for testing purposes.`

			`TestHost - A test version of Host. Only used for testing purposes.`

			`TestUsername - A test version of Username. Only used for testing purposes.`

			`TestPassword - A test version of Password. Only used for testing purposes.`

			`TestDbname - A test version of Dbname. Only used for testing purposes.`

			`TestPort - A test version of Port. Only used for testing purposes.`

			`# Dev`

			`DebugMode - Outputs a basic level of information about what Gosora is doing to help ease debugging.`

			`SuperDebug - Outputs a detailed level of information about what Gosora is doing to help ease debugging. Warning: This may cause severe slowdowns in Gosora.`

Added documentation for server timeouts. You can now disable server timeouts o.O Added a slightly more sophisticated WS Backoff algorithm. 2019-03-16 23:14:47 +00:00			`TemplateDebug - Output a detailed level of information about what Gosora is doing during the template transpilation step. Warning: Large amounts of information will be dumped into the logs.`
Added the configuration documentation file. 2019-02-20 05:35:18 +00:00
			`NoFsnotify - Whether you want to disable the file watcher which automatically reloads assets whenever they change.`