summaryrefslogtreecommitdiff
path: root/docs/configuration/media.md
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2021-11-14 16:54:23 +0100
committerLibravatar GitHub <noreply@github.com>2021-11-14 16:54:23 +0100
commitd81a123473c20af8e83b0c78986b199d55bfeb91 (patch)
tree74c13ccdd96b5506bb61afe50c437b5e950856f9 /docs/configuration/media.md
parentupdate drone file (#299) (diff)
downloadgotosocial-d81a123473c20af8e83b0c78986b199d55bfeb91.tar.xz
Update docs with better config + installation instructions (#300)
* start reworking some documentation * fuller documentation + better docs structure
Diffstat (limited to 'docs/configuration/media.md')
-rw-r--r--docs/configuration/media.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/configuration/media.md b/docs/configuration/media.md
new file mode 100644
index 000000000..2c5e778f7
--- /dev/null
+++ b/docs/configuration/media.md
@@ -0,0 +1,32 @@
+# Media
+
+## Settings
+
+```yaml
+########################
+##### MEDIA CONFIG #####
+########################
+
+# Config pertaining to user media uploads (videos, image, image descriptions).
+media:
+
+ # Int. Maximum allowed image upload size in bytes.
+ # Examples: [2097152, 10485760]
+ # Default: 2097152 -- aka 2MB
+ maxImageSize: 2097152
+
+ # Int. Maximum allowed video upload size in bytes.
+ # Examples: [2097152, 10485760]
+ # Default: 10485760 -- aka 10MB
+ maxVideoSize: 10485760
+
+ # Int. Minimum amount of characters required as an image or video description.
+ # Examples: [500, 1000, 1500]
+ # Default: 0 (not required)
+ minDescriptionChars: 0
+
+ # Int. Maximum amount of characters permitted in an image or video description.
+ # Examples: [500, 1000, 1500]
+ # Default: 500
+ maxDescriptionChars: 500
+```