summaryrefslogtreecommitdiff
path: root/docs/configuration/statuses.md
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2021-12-07 13:31:39 +0100
committerLibravatar GitHub <noreply@github.com>2021-12-07 13:31:39 +0100
commit0884f89431cd26bcc9674b3b7ab628b090f5881e (patch)
treecdd3b3f77f780a8b59d075dbcc3d4d013811e405 /docs/configuration/statuses.md
parentUpdate dependencies (#333) (diff)
downloadgotosocial-0884f89431cd26bcc9674b3b7ab628b090f5881e.tar.xz
Implement Cobra CLI tooling, Viper config tooling (#336)
* start pulling out + replacing urfave and config * replace many many instances of config * move more stuff => viper * properly remove urfave * move some flags to root command * add testrig commands to root * alias config file keys * start adding cli parsing tests * reorder viper init * remove config path alias * fmt * change config file keys to non-nested * we're more or less in business now * tidy up the common func * go fmt * get tests passing again * add note about the cliparsing tests * reorganize * update docs with changes * structure cmd dir better * rename + move some files around * fix dangling comma
Diffstat (limited to 'docs/configuration/statuses.md')
-rw-r--r--docs/configuration/statuses.md74
1 files changed, 35 insertions, 39 deletions
diff --git a/docs/configuration/statuses.md b/docs/configuration/statuses.md
index 606776a83..e0348dd5a 100644
--- a/docs/configuration/statuses.md
+++ b/docs/configuration/statuses.md
@@ -3,43 +3,39 @@
## Settings
```yaml
-##########################
-##### STORAGE CONFIG #####
-##########################
-
-# Config pertaining to storage of user-created uploads (videos, images, etc).
-storage:
-
- # String. Type of storage backend to use.
- # Examples: ["local", "s3"]
- # Default: "local" (storage on local disk)
- # NOTE: s3 storage is not yet supported!
- backend: "local"
-
- # String. Directory to use as a base path for storing files.
- # Make sure whatever user/group gotosocial is running as has permission to access
- # this directly, and create new subdirectories and files with in.
- # Examples: ["/home/gotosocial/storage", "/opt/gotosocial/datastorage"]
- # Default: "/gotosocial/storage"
- basePath: "/gotosocial/storage"
-
- # String. Protocol to use for serving stored files.
- # It's very unlikely that you'll need to change this ever, but there might be edge cases.
- # Examples: ["http", "https"]
- serveProtocol: "https"
-
- # String. Host for serving stored files.
- # If you're using local storage, this should be THE SAME as the value you've set for Host, above.
- # It should only be a different value if you're serving stored files from a host
- # other than the one your instance is running on.
- # Examples: ["localhost", "example.org"]
- # Default: "localhost" -- you should absolutely change this.
- serveHost: "localhost"
-
- # String. Base path for serving stored files. This will be added to serveHost and serveProtocol
- # to form the prefix url of your stored files. Eg., https://example.org/fileserver/.....
- # It's unlikely that you will need to change this.
- # Examples: ["/fileserver", "/media"]
- # Default: "/fileserver"
- serveBasePath: "/fileserver"
+###########################
+##### STATUSES CONFIG #####
+###########################
+
+# Config pertaining to the creation of statuses/posts, and permitted limits.
+
+# Int. Maximum amount of characters permitted for a new status.
+# Note that going way higher than the default might break federation.
+# Examples: [140, 500, 5000]
+# Default: 5000
+statuses-max-chars: 5000
+
+# Int. Maximum amount of characters allowed in the CW/subject header of a status.
+# Note that going way higher than the default might break federation.
+# Examples: [100, 200]
+# Default: 100
+statuses-cw-max-chars: 100
+
+# Int. Maximum amount of options to permit when creating a new poll.
+# Note that going way higher than the default might break federation.
+# Examples: [4, 6, 10]
+# Default: 6
+statuses-poll-max-options: 6
+
+# Int. Maximum amount of characters to permit per poll option when creating a new poll.
+# Note that going way higher than the default might break federation.
+# Examples: [50, 100, 150]
+# Default: 50
+statuses-poll-option-max-chars: 50
+
+# Int. Maximum amount of media files that can be attached to a new status.
+# Note that going way higher than the default might break federation.
+# Examples: [4, 6, 10]
+# Default: 6
+statuses-media-max-files: 6
```