liquid_feedback_frontend

annotate config/example.lua @ 1787:d32958e34141

find changesets by author, revision, files, or words in the commit message
The term frozen should not be used anymore
author bsw
date Wed Oct 20 15:09:17 2021 +0200 (2021-10-20)
parents 36fb14503a84
children
rev   line source
bsw@730 1 -- ========================================================================
bsw@813 2 -- MANDATORY (MUST BE CAREFULLY CHECKED AND PROPERLY SET!)
bsw@730 3 -- ========================================================================
bsw@525 4
bsw@1667 5 -- Absolute base url of application
bsw@1667 6 -- ------------------------------------------------------------------------
bsw@1667 7 config.absolute_base_url = "https://example.org/"
bsw@1667 8
bsw@1667 9 -- Connection information for the LiquidFeedback database
bsw@1667 10 -- ------------------------------------------------------------------------
bsw@1667 11 config.database = { engine='postgresql', dbname='liquid_feedback' }
bsw@1667 12
bsw@813 13 -- Name of this instance, defaults to name of config file
bsw@813 14 -- ------------------------------------------------------------------------
bsw@1656 15 config.instance_name = "Example Organisation"
bsw@813 16
bsw@1667 17 -- Information about service provider (HTML)
bsw@813 18 -- ------------------------------------------------------------------------
bsw@1667 19 config.app_service_provider = "Snake Oil<br/>10000 Berlin<br/>Germany"
bsw@1656 20
bsw@1656 21 -- Network interface to bind to
bsw@1656 22 -- ------------------------------------------------------------------------
bsw@1656 23 -- Available options:
bsw@1656 24 -- true: bind to localhost (default)
bsw@1656 25 -- false: bind to all interface
bsw@735 26 -- ------------------------------------------------------------------------
bsw@1656 27 -- config.localhost = true
bsw@1656 28
bsw@1656 29 -- Network port to bind to, default port 8080
bsw@1656 30 -- ------------------------------------------------------------------------
bsw@1656 31 -- config.port = 8080
bsw@1656 32
bsw@1656 33 -- Serving content via IPV6
bsw@1656 34 -- ------------------------------------------------------------------------
bsw@1656 35 -- Available options:
bsw@1656 36 -- nil or false: do not serve via IPv6 (default)
bsw@1656 37 -- true: serve via IPv6
bsw@1656 38 -- ------------------------------------------------------------------------
bsw@1656 39 -- config.ipv6 = false
bsw@79 40
bsw@1667 41 -- ========================================================================
bsw@1667 42 -- OPTIONAL
bsw@1667 43 -- Remove leading -- to use a option
bsw@1667 44 -- ========================================================================
bsw/jbe@6 45
bsw@813 46 -- Public access level
bsw@734 47 -- ------------------------------------------------------------------------
bsw@813 48 -- Available options:
bsw@1667 49 -- "none" (default)
bsw@813 50 -- -> Closed user group, no public access at all
bsw@813 51 -- (except login/registration/password reset)
bsw@813 52 -- "anonymous"
bsw@813 53 -- -> Shows only initiative/suggestions texts and aggregated
bsw@813 54 -- supporter/voter counts
bsw@813 55 -- "authors_pseudonymous"
bsw@813 56 -- -> Like anonymous, but shows screen names of authors
bsw@813 57 -- "all_pseudonymous"
bsw@813 58 -- -> Show everything a member can see, except profile pages
bsw@813 59 -- "everything"
bsw@813 60 -- -> Show everything a member can see, including profile pages
bsw@813 61 -- ------------------------------------------------------------------------
bsw@1667 62 -- config.public_access = "none"
bsw@731 63
bsw@729 64 -- List of enabled languages, defaults to available languages
bsw@730 65 -- ------------------------------------------------------------------------
bsw@1129 66 -- config.enabled_languages = { 'en', 'de', 'eo', 'el', 'hu', 'it', 'ka', 'nl', 'zh-Hans', 'zh-TW' }
bsw@2 67
bsw@729 68 -- Default language, defaults to "en"
bsw@730 69 -- ------------------------------------------------------------------------
bsw@729 70 -- config.default_lang = "en"
poelzi@163 71
bsw@1656 72 -- Disable registration
bsw@1656 73 -- ------------------------------------------------------------------------
bsw@1656 74 -- Available options:
bsw@1656 75 -- false: registration is enabled (default)
bsw@1656 76 -- true: registration is disabled
bsw@1656 77 -- ------------------------------------------------------------------------
bsw@1656 78 -- config.disable_registration = true
bsw@1656 79
bsw@1656 80 -- A HTML formatted text the user has to accept while registering
bsw@1656 81 -- ------------------------------------------------------------------------
bsw@1656 82 -- config.use_terms = "<h1>Terms of Use</h1><p>Insert terms here</p>"
bsw@1656 83
bsw@1656 84 -- Checkbox(es) the user has to accept while registering
bsw@1656 85 -- ------------------------------------------------------------------------
bsw@1656 86 -- config.use_terms_checkboxes = {
bsw@1656 87 -- {
bsw@1656 88 -- name = "terms_of_use_v1",
bsw@1656 89 -- html = "I accept the terms of use.",
bsw@1656 90 -- not_accepted_error = "You have to accept the terms of use to be able to register."
bsw@1656 91 -- },
bsw@1656 92 -- {
bsw@1656 93 -- name = "extra_terms_of_use_v1",
bsw@1656 94 -- html = "I accept the extra terms of use.",
bsw@1656 95 -- not_accepted_error = "You have to accept the extra terms of use to be able to register."
bsw@1656 96 -- }
bsw@1656 97 -- }
bsw@1656 98
bsw@734 99 -- after how long is a user considered inactive and the trustee will see warning,
bsw@734 100 -- notation is according to postgresql intervals, default: no warning at all
bsw@730 101 -- ------------------------------------------------------------------------
bsw@729 102 -- config.delegation_warning_time = '6 months'
bsw/jbe@6 103
bsw@988 104 -- after which time a user is advised (_soft) or forced (_hard) to check
bsw@988 105 -- unit and area delegations. default: no check at all
bsw@988 106 -- ------------------------------------------------------------------------
bsw@1656 107 -- config.check_delegations_interval_soft = "3 months"
bsw@988 108 -- config.check_delegations_interval_hard = "6 months"
bsw@988 109
bsw@988 110 -- default option when checking delegations
bsw@988 111 -- available options: "confirm", "revoke" and "none", default: "confirm"
bsw@988 112 -- ------------------------------------------------------------------------
bsw@988 113 -- config.check_delegations_default = "confirm"
bsw@988 114
bsw@734 115 -- Prefix of all automatic mails, defaults to "[Liquid Feedback] "
bsw@730 116 -- ------------------------------------------------------------------------
bsw@729 117 -- config.mail_subject_prefix = "[LiquidFeedback] "
bsw@734 118
bsw@734 119 -- Sender of all automatic mails, defaults to system defaults
bsw@734 120 -- ------------------------------------------------------------------------
bsw@839 121 -- config.mail_envelope_from = "liquidfeedback@example.com"
bsw@839 122 -- config.mail_from = { name = "LiquidFeedback", address = "liquidfeedback@example.com" }
bsw@839 123 -- config.mail_reply_to = { name = "Support", address = "support@example.com" }
bsw/jbe@6 124
bsw@1250 125 -- Template for digest emails
bsw@1250 126 -- #{name} will be replaced by member screen name
bsw@1250 127 -- #{digest} will be replaced with the digest content
bsw@1250 128 -- ------------------------------------------------------------------------
bsw@1250 129 -- config.notification_digest_template = [[
bsw@1250 130 -- Hello #{name},
bsw@1250 131 --
bsw@1250 132 -- this is your personal digest.
bsw@1250 133 --
bsw@1250 134 -- #{digest}
bsw@1250 135 -- ]]
bsw@1250 136
bsw@905 137 -- Configuration of password hashing algorithm (defaults to "crypt_sha512")
bsw@905 138 -- ------------------------------------------------------------------------
bsw@905 139 -- config.password_hash_algorithm = "crypt_sha512"
bsw@1206 140 -- config.password_hash_algorithm = "crypt_sha256"
bsw@905 141 -- config.password_hash_algorithm = "crypt_md5"
bsw@905 142
bsw@905 143 -- Number of rounds for crypt_sha* algorithms, minimum and maximum
bsw@905 144 -- (defaults to minimum 10000 and maximum 20000)
bsw@905 145 -- ------------------------------------------------------------------------
bsw@905 146 -- config.password_hash_min_rounds = 10000
bsw@905 147 -- config.password_hash_max_rounds = 20000
bsw@905 148
bsw@729 149 -- Local directory for database dumps offered for download
bsw@730 150 -- ------------------------------------------------------------------------
bsw@729 151 -- config.download_dir = nil
bsw@51 152
bsw@729 153 -- Special use terms for database dump download
bsw@730 154 -- ------------------------------------------------------------------------
bsw@729 155 -- config.download_use_terms = "=== Download use terms ===\n"
bsw/jbe@52 156
bsw@734 157 -- Use custom image conversion, defaults to ImageMagick's convert
bsw@730 158 -- ------------------------------------------------------------------------
bsw@729 159 --config.member_image_content_type = "image/jpeg"
bsw@729 160 --config.member_image_convert_func = {
bsw@729 161 -- avatar = function(data) return extos.pfilter(data, "convert", "jpeg:-", "-thumbnail", "48x48", "jpeg:-") end,
bsw@729 162 -- photo = function(data) return extos.pfilter(data, "convert", "jpeg:-", "-thumbnail", "240x240", "jpeg:-") end
bsw@729 163 --}
bsw@51 164
bsw@1656 165 -- Initiative attachments
bsw@1656 166 -- ------------------------------------------------------------------------
bsw@1656 167 -- config.attachments = {}
bsw@1656 168
bsw@1656 169 -- Conversion function for recoding attachments
bsw@1656 170 -- ------------------------------------------------------------------------
bsw@1656 171 -- config.attachments.convert_func = function(data)
bsw@1656 172 -- return extos.pfilter(data, "convert", "jpeg:-", "-thumbnail", "240x240", "jpeg:-")
bsw@1656 173 -- end
bsw@1656 174
bsw@1656 175 -- Custom UI colors, defaults to green/blue
bsw@1656 176 -- ------------------------------------------------------------------------
bsw@1656 177 -- config.style = {
bsw@1656 178 -- color_md = {
bsw@1656 179 -- primary = "green",
bsw@1656 180 -- primary_contrast = "dark",
bsw@1656 181 -- accent = "blue",
bsw@1656 182 -- accent_contrast = "dark"
bsw@1656 183 -- }
bsw@1656 184 -- }
bsw@1656 185
bsw@1656 186 -- Member profile fields, defaults to no extra fields
bsw@1656 187 -- ------------------------------------------------------------------------
bsw@1656 188 -- config.member_profile_fields = {}
bsw@1656 189
bsw@1045 190 -- Display a html formatted public message of the day
bsw@837 191 -- ------------------------------------------------------------------------
bsw@1045 192 -- config.motd_public = "<h1>Message of the day (public)</h1><p>The MOTD is formatted with HTML</p>"
bsw@1045 193
bsw@1045 194 -- Display a html formatted internal message of the day
bsw@1045 195 -- ------------------------------------------------------------------------
bsw@1045 196 -- config.motd_intern = "<h1>Message of the day (intern)</h1><p>The MOTD is formatted with HTML</p>"
bsw@837 197
bsw@961 198 -- Free timings
bsw@961 199 -- ------------------------------------------------------------------------
bsw@961 200 -- This example expects a date string entered in the free timing field
bsw@961 201 -- by the user creating a poll, interpreting it as target date for then
bsw@961 202 -- poll and splits the remaining time at the ratio of 4:1:2
bsw@961 203 -- Please note, polling policies never have an admission phase
bsw@961 204 -- The available_func is optional, if not set any target date is allowed
bsw@961 205
bsw@1222 206 --[[
bsw@961 207 config.free_timing = {
bsw@961 208 calculate_func = function(policy, timing_string)
bsw@1166 209 local function interval_by_seconds(secs)
bsw@961 210 local secs_per_day = 60 * 60 * 24
bsw@961 211 local days
bsw@961 212 days = math.floor(secs / secs_per_day)
bsw@961 213 secs = secs - days * secs_per_day
bsw@961 214 return days .. " days " .. secs .. " seconds"
bsw@961 215 end
bsw@961 216 local target_date = parse.date(timing_string, atom.date)
bsw@961 217 if not target_date then
bsw@961 218 return false
bsw@961 219 end
bsw@961 220 local target_timestamp = target_date.midday
bsw@961 221 local now = atom.timestamp:get_current()
bsw@961 222 trace.debug(target_timestamp, now)
bsw@961 223 local duration = target_timestamp - now
bsw@961 224 if duration < 0 then
bsw@961 225 return false
bsw@961 226 end
bsw@961 227 return {
bsw@961 228 discussion = interval_by_seconds(duration / 7 * 4),
bsw@961 229 verification = interval_by_seconds(duration / 7 * 1),
bsw@961 230 voting = interval_by_seconds(duration / 7 * 2)
bsw@961 231 }
bsw@961 232 end,
bsw@961 233 available_func = function(policy)
bsw@961 234 return {
bsw@961 235 { name = "End of 2013", id = '2013-12-31' },
bsw@961 236 { name = "End of 2014", id = '2014-12-31' },
bsw@961 237 { name = "End of 2015", id = '2015-12-31' }
bsw@961 238 }
bsw@961 239 end
bsw@961 240 }
bsw@1222 241 --]]
bsw@1170 242
bsw@1209 243 -- External references
bsw@1209 244 -- ------------------------------------------------------------------------
bsw@1209 245 -- Rendering of external references
bsw@1209 246
bsw@1209 247 --[[
bsw@1209 248 config.render_external_reference = {
bsw@1209 249 draft = function(draft, wrapper)
bsw@1209 250 wrapper(function()
bsw@1209 251 ui.tag{ content = draft.external_reference)
bsw@1209 252 end)
bsw@1209 253 end,
bsw@1209 254 initiative = function(initiative, wrapper)
bsw@1209 255 wrapper(function()
bsw@1209 256 ui.tag{ content = initiative.external_reference)
bsw@1209 257 end)
bsw@1209 258 end
bsw@1209 259 end
bsw@1209 260 --]]
bsw@1209 261
bsw@1656 262 -- Configuration of OAuth2 service, defaults to OAuth2 disabled
bsw@1656 263 -- ------------------------------------------------------------------------
bsw@1656 264 -- config.oauth2 = {}
bsw@1656 265
bsw@1656 266 -- Additional scopes
bsw@1656 267 -- config.oauth2.available_scopes = {
bsw@1656 268 -- { scope = "privA", name = { de = "Beispielprivileg A", en = "Example privilege A" } },
bsw@1656 269 -- { scope = "privB", name = { de = "Beispielprivileg B", en = "Example privilege B" } }
bsw@1656 270 -- }
bsw@1656 271
bsw@1656 272 -- OAuth2 endpoint magic string for dynamic app registration
bsw@1656 273 -- ------------------------------------------------------------------------
bsw@1656 274 -- config.oauth2.endpoint_magic = "liquidfeedback_client_redirection_endpoint"
bsw@1656 275
bsw@1656 276 -- OAuth2 Token lifetime and timings
bsw@1656 277 -- ------------------------------------------------------------------------
bsw@1656 278 -- config.oauth2.authorization_code_lifetime = 5 * 60
bsw@1656 279 -- config.oauth2.refresh_token_lifetime = 60 * 60 * 24 * 30 * 3
bsw@1656 280 -- config.oauth2.refresh_pause = 60
bsw@1656 281 -- config.oauth2.refresh_grace_period = 60
bsw@1656 282 -- config.oauth2.access_token_lifetime = 60 * 60
bsw@1656 283
bsw@1106 284 -- Admin logger
bsw@1106 285 -- ------------------------------------------------------------------------
bsw@1106 286 -- Logging administrative activities
bsw@1106 287 -- disabled by default
bsw@1106 288
bsw@1656 289 -- config.admin_logger = function(params)
bsw@1656 290 -- local adminid = app.session.member_id
bsw@1656 291 -- local adminname = app.session.member.name
bsw@1656 292 -- local url = params._webmcp_path
bsw@1656 293 -- -- do something (e.g. calling 'logger' via extos.pfilter)
bsw@1656 294 -- end
bsw@1106 295
bsw@1170 296 -- Application server fork configuration
bsw@1170 297 -- ------------------------------------------------------------------------
bsw@1170 298 -- config.fork = {
bsw@1170 299 -- pre = 2, -- desired number of spare (idle) processes
bsw@1170 300 -- min = 4, -- minimum number of processes
bsw@1170 301 -- max = 128, -- maximum number of processes (hard limit)
bsw@1170 302 -- delay = 0.125, -- delay (seconds) between creation of spare processes
bsw@1170 303 -- error_delay = 2, -- delay (seconds) before retry of failed process creation
bsw@1170 304 -- exit_delay = 2, -- delay (seconds) between destruction of excessive spare processes
bsw@1170 305 -- idle_timeout = 900, -- idle time (seconds) after a fork gets terminated (0 for no timeout)
bsw@1170 306 -- memory_limit = 0, -- maximum memory consumption (bytes) before process gets terminated
bsw@1170 307 -- min_requests = 50, -- minimum count of requests handled before fork is terminated
bsw@1170 308 -- max_requests = 100 -- maximum count of requests handled before fork is terminated
bsw@1170 309 -- }
bsw@1170 310
bsw@1170 311 -- HTTP server options
bsw@1170 312 -- ------------------------------------------------------------------------
bsw@1170 313 -- http_options = {
bsw@1170 314 -- static_headers = {} -- string or table of static headers to be returned with every request
bsw@1170 315 -- request_header_size_limit = 1024*1024, -- maximum size of request body sent by client
bsw@1170 316 -- request_body_size_limit = 64*1024*1024, -- maximum size of request body sent by client
jbe@1198 317 -- idle_timeout = 65, -- maximum time until receiving the first byte of the request headera
jbe@1198 318 -- stall_timeout = 60, -- maximum time a client connection may be stalled
jbe@1198 319 -- request_header_timeout = 120, -- maximum time until receiving the remaining bytes of the request header
jbe@1198 320 -- response_timeout = 3600, -- time in which request body and response must be sent
bsw@1170 321 -- maximum_input_chunk_size = 16384 -- tweaks behavior of request-body parser
bsw@1170 322 -- minimum_output_chunk_size = 1024 -- chunk size for chunked-transfer-encoding
bsw@1170 323 -- }
bsw@1170 324
bsw@729 325 -- WebMCP accelerator
jbe@1223 326 -- ------------------------------------------------------------------------
jbe@1223 327 -- uncomment the following line to use C implementations of chosen
jbe@1223 328 -- functions:
bsw@730 329 -- ------------------------------------------------------------------------
bsw@729 330 -- require 'webmcp_accelerator'
jbe@1223 331
bsw@868 332 -- Trace debug
bsw@1222 333 -- ------------------------------------------------------------------------
bsw@868 334 -- uncomment the following line to enable debug trace
jbe@1223 335 -- ------------------------------------------------------------------------
bsw@1656 336 -- config.enable_debug_trace = true
bsw@1656 337
bsw@1656 338 -- Configuration of lf4rcs, disabled by default
bsw@1656 339 -- for example configration see _lf4rcs.lua
bsw@1656 340 -- ------------------------------------------------------------------------
bsw@1656 341 -- execute.config("_lf4rcs")
bsw@1656 342
bsw@1656 343 -- Configuration of ldap authentication, disabled by default
bsw@1656 344 -- for example configration, see _ldap.lua
bsw@1656 345 -- for active directory example, see _ldap_ad.lua
bsw@1656 346 -- ------------------------------------------------------------------------
bsw@1656 347 -- execute.config("_ldap")
bsw@1656 348 -- execute.config("_ldap_ad")
bsw/jbe@1309 349
bsw@1656 350 -- Integration of Etherpad, disabled by default
bsw@1656 351 -- ------------------------------------------------------------------------
bsw@1656 352 --config.etherpad = {
bsw@1656 353 -- base_url = "http://example.com:9001/",
bsw@1656 354 -- api_base = "http://localhost:9001/",
bsw@1656 355 -- api_key = "mysecretapikey",
bsw@1656 356 -- group_id = "mygroupname",
bsw@1656 357 -- cookie_path = "/"
bsw@1656 358 --}
bsw/jbe@0 359
bsw@1656 360 -- Integration of FirstLife
bsw@1656 361 -- ------------------------------------------------------------------------
bsw@1656 362 --[[
bsw@1656 363 config.firstlife = {
bsw@1656 364 coordinates = "",
bsw@1656 365 areaviewer_url = "about:blank",
bsw@1656 366 inputmap_url = "about:blank"
bsw/jbe@1309 367 }
bsw@1656 368 config.allow_new_draft_callback = true
bsw@1656 369 --]]
bsw/jbe@1309 370

Impressum / About Us