Improve config files by adding documentation and removing some fields

This commit is contained in:
Felix Ableitner 2020-06-24 16:09:52 +02:00
parent b94d380729
commit a9d98fd09b
3 changed files with 33 additions and 44 deletions

View file

@ -1,13 +1,25 @@
{ {
# for more info about the config, check out the documentation
# https://dev.lemmy.ml/docs/administration_configuration.html
# settings related to the postgresql database
database: { database: {
# password to connect to postgres
password: "{{ postgres_password }}" password: "{{ postgres_password }}"
# host where postgres is running
host: "postgres" host: "postgres"
} }
# the domain name of your instance (eg "dev.lemmy.ml")
hostname: "{{ domain }}" hostname: "{{ domain }}"
# json web token for authorization between server and client
jwt_secret: "{{ jwt_password }}" jwt_secret: "{{ jwt_password }}"
# The location of the frontend
front_end_dir: "/app/dist" front_end_dir: "/app/dist"
# email sending configuration
email: { email: {
# hostname of the smtp server
smtp_server: "postfix:25" smtp_server: "postfix:25"
# address to send emails from, eg "noreply@your-instance.com"
smtp_from_address: "noreply@{{ domain }}" smtp_from_address: "noreply@{{ domain }}"
use_tls: false use_tls: false
} }

57
docker/lemmy.hjson vendored
View file

@ -1,18 +1,7 @@
{ {
database: { # for more info about the config, check out the documentation
# username to connect to postgres # https://dev.lemmy.ml/docs/administration_configuration.html
user: "lemmy"
# password to connect to postgres
password: "password"
# host where postgres is running
host: "postgres"
# port where postgres can be accessed
port: 5432
# name of the postgres database for lemmy
database: "lemmy"
# maximum number of active sql connections
pool_size: 5
}
# the domain name of your instance (eg "dev.lemmy.ml") # the domain name of your instance (eg "dev.lemmy.ml")
hostname: "my_domain" hostname: "my_domain"
# address where lemmy should listen for incoming requests # address where lemmy should listen for incoming requests
@ -21,32 +10,19 @@
port: 8536 port: 8536
# json web token for authorization between server and client # json web token for authorization between server and client
jwt_secret: "changeme" jwt_secret: "changeme"
# The dir for the front end # settings related to the postgresql database
front_end_dir: "/app/dist" database: {
# rate limits for various user actions, by user ip # name of the postgres database for lemmy
rate_limit: { database: "lemmy"
# maximum number of messages created in interval # username to connect to postgres
message: 180 user: "lemmy"
# interval length for message limit # password to connect to postgres
message_per_second: 60 password: "password"
# maximum number of posts created in interval # host where postgres is running
post: 6 host: "postgres"
# interval length for post limit # port where postgres can be accessed
post_per_second: 600 port: 5432
# maximum number of registrations in interval
register: 3
# interval length for registration limit
register_per_second: 3600
} }
# # optional: parameters for automatic configuration of new instance (only used at first start)
# setup: {
# # username for the admin user
# admin_username: "lemmy"
# # password for the admin user
# admin_password: "lemmy"
# # name of the site (can be changed later)
# site_name: "Lemmy Test"
# }
# # optional: email sending configuration # # optional: email sending configuration
# email: { # email: {
# # hostname of the smtp server # # hostname of the smtp server
@ -55,9 +31,8 @@
# smtp_login: "" # smtp_login: ""
# # password to login to the smtp server # # password to login to the smtp server
# smtp_password: "" # smtp_password: ""
# # address to send emails from, eg "info@your-instance.com" # # address to send emails from, eg "noreply@your-instance.com"
# smtp_from_address: "" # smtp_from_address: ""
# use_tls: true
# } # }
} }

View file

@ -33,7 +33,7 @@
port: 8536 port: 8536
# json web token for authorization between server and client # json web token for authorization between server and client
jwt_secret: "changeme" jwt_secret: "changeme"
# The dir for the front end # The location of the frontend
front_end_dir: "../ui/dist" front_end_dir: "../ui/dist"
# whether to enable activitypub federation. this feature is in alpha, do not enable in production, as might # whether to enable activitypub federation. this feature is in alpha, do not enable in production, as might
# cause problems like remote instances fetching and permanently storing bad data. # cause problems like remote instances fetching and permanently storing bad data.
@ -55,13 +55,15 @@
} }
# # email sending configuration # # email sending configuration
# email: { # email: {
# # hostname of the smtp server # # hostname and port of the smtp server
# smtp_server: "" # smtp_server: ""
# # login name for smtp server # # login name for smtp server
# smtp_login: "" # smtp_login: ""
# # password to login to the smtp server # # password to login to the smtp server
# smtp_password: "" # smtp_password: ""
# # address to send emails from, eg "info@your-instance.com" # # address to send emails from, eg "noreply@your-instance.com"
# smtp_from_address: "" # smtp_from_address: ""
# # whether or not smtp connections should use tls
# use_tls: true
# } # }
} }