diff options
Diffstat (limited to 'docs/configuration')
| -rw-r--r-- | docs/configuration/index.md | 6 | ||||
| -rw-r--r-- | docs/configuration/instance.md | 15 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 5aa10df9a..e113e8ecb 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -38,6 +38,12 @@ GTS_MEDIA_IMAGE_MAX_SIZE=2097152 If you're in doubt about any of the names of these environment variables, just check the `--help` for the subcommand you're using. +!!! tip "Environment variable arrays" + + If you need to use an environment variable to set a configuration option that accepts an array, provide each value in a comma-separated list. + + For example, `instance-languages` may be set in the config.yaml file as an array like so: `["nl", "de", "fr", "en"]`. To set the same values as an environment variable, use: `GTS_INSTANCE_LANGUAGES="nl,de,fr,en"` + ### Command Line Flags Finally, you can set configuration values using command-line flags, which you pass directly when you're running a `gotosocial` command. For example, instead of setting `media-image-max-size` in your config.yaml, or with an environment variable, you can pass the value directly through the command line: diff --git a/docs/configuration/instance.md b/docs/configuration/instance.md index 61f58c9a3..0be3d52be 100644 --- a/docs/configuration/instance.md +++ b/docs/configuration/instance.md @@ -9,6 +9,21 @@ # Config pertaining to instance federation settings, pages to hide/expose, etc. +# Array of string. BCP47 language tags to indicate preferred languages of users on this instance. +# +# If you provide these, you should provide these in order from most-preferred to least-preferred, +# but note that leaving out a language from this array doesn't mean it can't be used on this instance, +# it only means it won't be advertised as a preferred instance language. +# +# It is valid to provide no entries here; your instance will then have no particular preferred language. +# +# See here for commonly-used tags: https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags +# See here for all current tags: https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry +# +# Example: ["nl", "en-gb", "fr"] +# Default: [] +instance-languages: [] + # String. Federation mode to use for this instance. # # "blocklist" -- open federation by default. Only instances that are explicitly |