diff options
author | 2022-06-03 15:40:38 +0200 | |
---|---|---|
committer | 2022-06-03 15:40:38 +0200 | |
commit | 327d3f001f1cc219c4a718edf23b976c29c19487 (patch) | |
tree | 7fbc505601461f22eeeea6e966b9df5a43b4cafc /docs/configuration/advanced.md | |
parent | [chore] Adds Issue templates to Github (#626) (diff) | |
download | gotosocial-327d3f001f1cc219c4a718edf23b976c29c19487.tar.xz |
[feature] Start adding advanced configuration options, starting with `samesite` (#628)
* fix incorrect port being used for db
* start adding advanced config flags
* use samesite lax by default
Diffstat (limited to 'docs/configuration/advanced.md')
-rw-r--r-- | docs/configuration/advanced.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/configuration/advanced.md b/docs/configuration/advanced.md new file mode 100644 index 000000000..48b1b569d --- /dev/null +++ b/docs/configuration/advanced.md @@ -0,0 +1,38 @@ +# Advanced + +Advanced settings options are provided for the sake of allowing admins to tune their instance to their liking. + +These are set to sensible defaults, so most server admins won't need to touch them or think about them. + +**Changing these settings if you don't know what you're doing may break your instance**. + +## Settings + +```yaml +############################# +##### ADVANCED SETTINGS ##### +############################# + +# Advanced settings pertaining to http timeouts, security, cookies, and more. +# +# ONLY ADJUST THESE SETTINGS IF YOU KNOW WHAT YOU ARE DOING! +# +# Most users will not need to (and should not) touch these settings, since +# they are set to sensible defaults, and may break if they are changed. +# +# Nevertheless, they are provided for the sake of allowing server admins to +# tweak their instance for performance or security reasons. + +# String. Value of the SameSite attribute of cookies set by GoToSocial. +# Defaults to 'lax' to ensure that the OIDC flow does not break, which is +# fine in most cases. If you want to harden your instance against CSRF attacks +# and don't mind if some login-related things might break, you can set this +# to 'strict' instead. +# +# For an overview of what this does, see: +# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite +# +# Options: ["lax", "strict"] +# Default: "lax" +advanced-cookies-samesite: "lax" +``` |