diff options
| author |  Daenney <daenney@users.noreply.github.com> | 2023-12-05 11:44:10 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2023-12-05 11:44:10 +0100 |
| commit | 5556767ff73befa2ebe800d18099849bc79f3301 (patch) | |
| tree | 259990277ee9f4034b8e838db99e4d1c1625bf81 /docs/configuration/index.md | |
| parent | [bugfix/chore] `Announce` reliability updates (#2405) (diff) | |
| download | gotosocial-5556767ff73befa2ebe800d18099849bc79f3301.tar.xz | |
[docs] Change configuration creation instructions (#2408)
* [docs] Change configuration creation instructions
This changes the wording to push people towards creating their own
configuration, without copying the whole example configuration. This
makes it much easier to reconcile necessary configruation changes on
upgrades.
* [docs] Reword container version section
This changes the wording in the Version section to make it more clear
what the risks of a moving tag are. It pushes people to use an explicit
release tag instead.
Diffstat (limited to 'docs/configuration/index.md')
| -rw-r--r-- | docs/configuration/index.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/configuration/index.md b/docs/configuration/index.md index e113e8ecb..401bbf3f5 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -18,9 +18,9 @@ gotosocial --config-path ./config.yaml server start The command expects a file in [YAML](https://en.wikipedia.org/wiki/YAML) or [JSON](https://en.wikipedia.org/wiki/JSON) format. -An example configuration file, with an explanation of each of the config fields, with default and example values, can be found [here](https://github.com/superseriousbusiness/gotosocial/blob/main/example/config.yaml). +An example configuration file, with an explanation of each of the config fields, with default and example values, can be found [here](https://github.com/superseriousbusiness/gotosocial/blob/main/example/config.yaml). This example file is also included in release downloads. -This example file is included with release downloads, so you can just copy it and edit it to your needs without having to worry too much about what the hell YAML or JSON is. +It's recommended to create your own configuration file with only the settings you need to change for your installation. This ensures you don't have to reconcile changes to defaults or adding/updating/removing settings from your configuration file that you haven't changed away from the defaults on every release. ### Environment Variables |