From 1212915bf6486c54c5aa9cdfbc630b175048626f Mon Sep 17 00:00:00 2001
From: "Alexander \"Arav\" Andreev" <me@arav.top>
Date: Tue, 8 Feb 2022 23:09:19 +0400
Subject: [PATCH] Added comments for options. Fixed a typo clean ->clear.

---
 configs/config.yaml | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/configs/config.yaml b/configs/config.yaml
index 962ead2..b6e5eb1 100644
--- a/configs/config.yaml
+++ b/configs/config.yaml
@@ -1,17 +1,36 @@
+# Sets network type (could be tcp{,4,6}, unix)
+# and address:port or /path/to/unix.socket to
+# listen on.
 listen_on: "tcp :29101"
+# Salt for hash of uploaded files.
+# Aim is to make useless a bruteforce of links.
 hash_salt: "iyP3oZWHI3xO3XBF7s78Vg"
+# User a program runs as. Make sure that all
+# paths are accessible by that user.
 user: "dwupload"
+# Chroot directory. No chrooting if empty.
+# Make sure all directories are created within
+# chroot directory. All paths becomes related
+# to chroot.
 chroot: ""
+# Logging options.
 log:
+  # Output messages to stdout as well as to theirs files.
   stdout: true
+  # dwelling-upload logs.
   error: "/var/log/dwelling-upload/error.log"
   upload: "/var/log/dwelling-upload/upload.log"
   download: "/var/log/dwelling-upload/download.log"
-  clean: "/var/log/dwelling-upload/clean.log"
-  clean_error: "/var/log/dwelling-upload/clean_error.log"
+  # dwelling-upload-clear logs.
+  clear: "/var/log/dwelling-upload/clear.log"
+  clear_error: "/var/log/dwelling-upload/clear_error.log"
 uploads:
+  # Path where to put uploaded files.
   directory: "/srv/uploads"
   limits:
+    # Maximum size of a file in MiB.
     file_size: 128
+    # Amount of hours file will be keeped for.
     keep_for_hours: 48
+    # Maximum size of a whole storage in MiB.
     storage: 204800
\ No newline at end of file