From a9d98fd09bc8cc337266c55a6f2a8e58a421d9aa Mon Sep 17 00:00:00 2001 From: Felix Ableitner Date: Wed, 24 Jun 2020 16:09:52 +0200 Subject: [PATCH] Improve config files by adding documentation and removing some fields --- ansible/templates/config.hjson | 12 ++++++++ docker/lemmy.hjson | 55 ++++++++++------------------------ server/config/defaults.hjson | 8 +++-- 3 files changed, 32 insertions(+), 43 deletions(-) diff --git a/ansible/templates/config.hjson b/ansible/templates/config.hjson index c0f387c4..72d7c58c 100644 --- a/ansible/templates/config.hjson +++ b/ansible/templates/config.hjson @@ -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: { + # password to connect to postgres password: "{{ postgres_password }}" + # host where postgres is running host: "postgres" } + # the domain name of your instance (eg "dev.lemmy.ml") hostname: "{{ domain }}" + # json web token for authorization between server and client jwt_secret: "{{ jwt_password }}" + # The location of the frontend front_end_dir: "/app/dist" + # email sending configuration email: { + # hostname of the smtp server smtp_server: "postfix:25" + # address to send emails from, eg "noreply@your-instance.com" smtp_from_address: "noreply@{{ domain }}" use_tls: false } diff --git a/docker/lemmy.hjson b/docker/lemmy.hjson index 271fc78d..c8dd2818 100644 --- a/docker/lemmy.hjson +++ b/docker/lemmy.hjson @@ -1,5 +1,19 @@ { + # for more info about the config, check out the documentation + # https://dev.lemmy.ml/docs/administration_configuration.html + + # the domain name of your instance (eg "dev.lemmy.ml") + hostname: "my_domain" + # address where lemmy should listen for incoming requests + bind: "0.0.0.0" + # port where lemmy should listen for incoming requests + port: 8536 + # json web token for authorization between server and client + jwt_secret: "changeme" + # settings related to the postgresql database database: { + # name of the postgres database for lemmy + database: "lemmy" # username to connect to postgres user: "lemmy" # password to connect to postgres @@ -8,45 +22,7 @@ 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") - hostname: "my_domain" - # address where lemmy should listen for incoming requests - bind: "0.0.0.0" - # port where lemmy should listen for incoming requests - port: 8536 - # json web token for authorization between server and client - jwt_secret: "changeme" - # The dir for the front end - front_end_dir: "/app/dist" - # rate limits for various user actions, by user ip - rate_limit: { - # maximum number of messages created in interval - message: 180 - # interval length for message limit - message_per_second: 60 - # maximum number of posts created in interval - post: 6 - # interval length for post limit - post_per_second: 600 - # 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 # email: { # # hostname of the smtp server @@ -55,9 +31,8 @@ # smtp_login: "" # # password to login to the smtp server # 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: "" -# use_tls: true # } } diff --git a/server/config/defaults.hjson b/server/config/defaults.hjson index 97b9429c..482a7208 100644 --- a/server/config/defaults.hjson +++ b/server/config/defaults.hjson @@ -33,7 +33,7 @@ port: 8536 # json web token for authorization between server and client jwt_secret: "changeme" - # The dir for the front end + # The location of the frontend front_end_dir: "../ui/dist" # 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. @@ -55,13 +55,15 @@ } # # email sending configuration # email: { -# # hostname of the smtp server +# # hostname and port of the smtp server # smtp_server: "" # # login name for smtp server # smtp_login: "" # # password to login to the smtp server # 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: "" +# # whether or not smtp connections should use tls +# use_tls: true # } } -- 2.44.1