Update config description

This commit is contained in:
r 2020-08-07 09:27:05 +00:00
parent 5e0afa1533
commit 61020d8837

View file

@ -5,14 +5,19 @@
# - 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.
# previously generated access tokens and client tokens to be invalid. Issue the
# `rm -r 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"
# Example: ":8080", "bloat.mydomain.com"
listen_address=127.0.0.1:8080
# Full URL of the website. Users will be redirected to this URL after
# authentication.
# Example: "http://localhost:8080", "https://bloat.mydomain.com"
client_website=http://127.0.0.1:8080
# Name of the client.
client_name=bloat
@ -20,18 +25,6 @@ client_name=bloat
# 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
# In single instance mode, bloat will not ask for instance domain name and
# user will be directly redirected to login form. User login from other
# instances is not allowed in this mode.
# Empty value disables single instance mode.
# Example: "mydomain.com"
single_instance=
# Path of database directory. It's used to store session information.
database_path=database
@ -46,7 +39,13 @@ static_directory=static
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=
# log_file=log
# In single instance mode, bloat will not ask for instance domain name and
# user will be directly redirected to login form. User login from other
# instances is not allowed in this mode.
# Empty value disables single instance mode.
# single_instance=pl.mydomain.com
# Path to custom CSS. Value can be a file path relative to the static directory.
# or a URL starting with either "http://" or "https://".