# HG changeset patch
# User bsw
# Date 1614511356 -3600
# Node ID 36fb14503a841adf9b935fc524765c11899217a2
# Parent f582e3d6434c73efdd8297e5057658ad299fbdf4
Polishing example config
diff -r f582e3d6434c -r 36fb14503a84 config/example.lua
--- a/config/example.lua Mon Feb 15 15:31:12 2021 +0100
+++ b/config/example.lua Sun Feb 28 12:22:36 2021 +0100
@@ -2,20 +2,21 @@
-- MANDATORY (MUST BE CAREFULLY CHECKED AND PROPERLY SET!)
-- ========================================================================
+-- Absolute base url of application
+-- ------------------------------------------------------------------------
+config.absolute_base_url = "https://example.org/"
+
+-- Connection information for the LiquidFeedback database
+-- ------------------------------------------------------------------------
+config.database = { engine='postgresql', dbname='liquid_feedback' }
+
-- Name of this instance, defaults to name of config file
-- ------------------------------------------------------------------------
config.instance_name = "Example Organisation"
-
--- Connection information for the LiquidFeedback database
+-- Information about service provider (HTML)
-- ------------------------------------------------------------------------
-config.database = { engine='postgresql', dbname='liquid_feedback' }
-
-
--- Absolute base url of application
--- ------------------------------------------------------------------------
-config.absolute_base_url = "https://example.org/"
-
+config.app_service_provider = "Snake Oil
10000 Berlin
Germany"
-- Network interface to bind to
-- ------------------------------------------------------------------------
@@ -25,12 +26,10 @@
-- ------------------------------------------------------------------------
-- config.localhost = true
-
-- Network port to bind to, default port 8080
-- ------------------------------------------------------------------------
-- config.port = 8080
-
-- Serving content via IPV6
-- ------------------------------------------------------------------------
-- Available options:
@@ -39,11 +38,15 @@
-- ------------------------------------------------------------------------
-- config.ipv6 = false
+-- ========================================================================
+-- OPTIONAL
+-- Remove leading -- to use a option
+-- ========================================================================
-- Public access level
-- ------------------------------------------------------------------------
-- Available options:
--- "none"
+-- "none" (default)
-- -> Closed user group, no public access at all
-- (except login/registration/password reset)
-- "anonymous"
@@ -56,30 +59,16 @@
-- "everything"
-- -> Show everything a member can see, including profile pages
-- ------------------------------------------------------------------------
-config.public_access = "none"
-
-
--- Information about service provider (HTML)
--- ------------------------------------------------------------------------
-config.app_service_provider = "Snake Oil
10000 Berlin
Germany"
-
-
-
--- ========================================================================
--- OPTIONAL
--- Remove leading -- to use a option
--- ========================================================================
+-- config.public_access = "none"
-- List of enabled languages, defaults to available languages
-- ------------------------------------------------------------------------
-- config.enabled_languages = { 'en', 'de', 'eo', 'el', 'hu', 'it', 'ka', 'nl', 'zh-Hans', 'zh-TW' }
-
-- Default language, defaults to "en"
-- ------------------------------------------------------------------------
-- config.default_lang = "en"
-
-- Disable registration
-- ------------------------------------------------------------------------
-- Available options:
@@ -88,12 +77,10 @@
-- ------------------------------------------------------------------------
-- config.disable_registration = true
-
-- A HTML formatted text the user has to accept while registering
-- ------------------------------------------------------------------------
-- config.use_terms = "
Insert terms here
" - -- Checkbox(es) the user has to accept while registering -- ------------------------------------------------------------------------ -- config.use_terms_checkboxes = { @@ -114,32 +101,27 @@ -- ------------------------------------------------------------------------ -- config.delegation_warning_time = '6 months' - -- after which time a user is advised (_soft) or forced (_hard) to check -- unit and area delegations. default: no check at all -- ------------------------------------------------------------------------ -- config.check_delegations_interval_soft = "3 months" -- config.check_delegations_interval_hard = "6 months" - -- default option when checking delegations -- available options: "confirm", "revoke" and "none", default: "confirm" -- ------------------------------------------------------------------------ -- config.check_delegations_default = "confirm" - -- Prefix of all automatic mails, defaults to "[Liquid Feedback] " -- ------------------------------------------------------------------------ -- config.mail_subject_prefix = "[LiquidFeedback] " - -- Sender of all automatic mails, defaults to system defaults -- ------------------------------------------------------------------------ -- config.mail_envelope_from = "liquidfeedback@example.com" -- config.mail_from = { name = "LiquidFeedback", address = "liquidfeedback@example.com" } -- config.mail_reply_to = { name = "Support", address = "support@example.com" } - -- Template for digest emails -- #{name} will be replaced by member screen name -- #{digest} will be replaced with the digest content @@ -152,31 +134,26 @@ -- #{digest} -- ]] - -- Configuration of password hashing algorithm (defaults to "crypt_sha512") -- ------------------------------------------------------------------------ -- config.password_hash_algorithm = "crypt_sha512" -- config.password_hash_algorithm = "crypt_sha256" -- config.password_hash_algorithm = "crypt_md5" - -- Number of rounds for crypt_sha* algorithms, minimum and maximum -- (defaults to minimum 10000 and maximum 20000) -- ------------------------------------------------------------------------ -- config.password_hash_min_rounds = 10000 -- config.password_hash_max_rounds = 20000 - -- Local directory for database dumps offered for download -- ------------------------------------------------------------------------ -- config.download_dir = nil - -- Special use terms for database dump download -- ------------------------------------------------------------------------ -- config.download_use_terms = "=== Download use terms ===\n" - -- Use custom image conversion, defaults to ImageMagick's convert -- ------------------------------------------------------------------------ --config.member_image_content_type = "image/jpeg" @@ -210,19 +187,14 @@ -- ------------------------------------------------------------------------ -- config.member_profile_fields = {} - - -- Display a html formatted public message of the day -- ------------------------------------------------------------------------ -- config.motd_public = "The MOTD is formatted with HTML
" - -- Display a html formatted internal message of the day -- ------------------------------------------------------------------------ -- config.motd_intern = "The MOTD is formatted with HTML
" - - -- Free timings -- ------------------------------------------------------------------------ -- This example expects a date string entered in the free timing field @@ -268,7 +240,6 @@ } --]] - -- External references -- ------------------------------------------------------------------------ -- Rendering of external references @@ -288,7 +259,6 @@ end --]] - -- Configuration of OAuth2 service, defaults to OAuth2 disabled -- ------------------------------------------------------------------------ -- config.oauth2 = {} @@ -311,8 +281,6 @@ -- config.oauth2.refresh_grace_period = 60 -- config.oauth2.access_token_lifetime = 60 * 60 - - -- Admin logger -- ------------------------------------------------------------------------ -- Logging administrative activities @@ -325,9 +293,6 @@ -- -- do something (e.g. calling 'logger' via extos.pfilter) -- end - - - -- Application server fork configuration -- ------------------------------------------------------------------------ -- config.fork = { @@ -343,7 +308,6 @@ -- max_requests = 100 -- maximum count of requests handled before fork is terminated -- } - -- HTTP server options -- ------------------------------------------------------------------------ -- http_options = { @@ -358,7 +322,6 @@ -- minimum_output_chunk_size = 1024 -- chunk size for chunked-transfer-encoding -- } - -- WebMCP accelerator -- ------------------------------------------------------------------------ -- uncomment the following line to use C implementations of chosen @@ -366,20 +329,17 @@ -- ------------------------------------------------------------------------ -- require 'webmcp_accelerator' - -- Trace debug -- ------------------------------------------------------------------------ -- uncomment the following line to enable debug trace -- ------------------------------------------------------------------------ -- config.enable_debug_trace = true - -- Configuration of lf4rcs, disabled by default -- for example configration see _lf4rcs.lua -- ------------------------------------------------------------------------ -- execute.config("_lf4rcs") - -- Configuration of ldap authentication, disabled by default -- for example configration, see _ldap.lua -- for active directory example, see _ldap_ad.lua @@ -387,7 +347,6 @@ -- execute.config("_ldap") -- execute.config("_ldap_ad") - -- Integration of Etherpad, disabled by default -- ------------------------------------------------------------------------ --config.etherpad = { @@ -409,4 +368,3 @@ config.allow_new_draft_callback = true --]] -