Update config

1 files changed, 41 insertions, 4 deletions

diff --git a/bloat.conf b/bloat.conf
index 81ed26a..2ba265a 100644
--- a/bloat.conf
+++ b/bloat.conf
@@ -1,9 +1,46 @@
+# Format:
+# - Lines starting with a '#' are ignored
+# - Key and Value are separated by a single '='
+# - Leading and trailing white spaces in Key and Value are ignored
+# - Quoting and multi-line values are not supported
+#
+# Changing values of client_name, client_scope or client_website will cause
+# previously generated access tokens to be invalid. Issue the 
+# `rm database_path/*` command to clean the database afterwards.
+
+# Address to listen to. Value can be of "HOSTNAME:PORT" or "IP:PORT" form. In
+# case of empty HOSTNAME or IP, "0.0.0.0:PORT" is used.
+# Example: ":8080", "127.0.0.1:8080", "mydomain:8080"
 listen_address=:8080
+
+# Name of the client.
 client_name=web
+
+# Mastodon scopes used by the client.
+# See https://docs.joinmastodon.org/api/oauth-scopes/
 client_scope=read write follow
+
+# Full URL of the website. Users will be redirected to this URL after
+# authentication.
+# Example: "http://localhost:8080", "https://mydomain.com"
 client_website=http://localhost:8080
-static_directory=static
-templates_glob_pattern=templates/*
-#custom_css=custom.css
-#post_formats=PlainText:text/plain,HTML:text/html,Markdown:text/markdown,BBCode:text/bbcode
+
+# Path of database directory. It's used to store session information.
 database_path=database
+
+# Path of directory containing template files.
+templates_path=templates
+
+# Path of directory containing static files (CSS and JS).
+static_directory=static
+
+# Supported post formats. Value is a list of key:value pair separated by a ','.
+# Empty value will disable the format selection in frontend.
+post_formats=PlainText:text/plain,HTML:text/html,Markdown:text/markdown,BBCode:text/bbcode
+
+# Log file. Will log to stdout if value is empty.
+log_file=
+
+# Path to custom CSS. Value can be a file path relative to the static directory.
+# or a URL starting with either "http://" or "https://".
+# custom_css=custom.css