liquid_feedback_frontend

annotate config/example.lua @ 1235:7f818548b7b8

find changesets by author, revision, files, or words in the commit message
Added push grace period for verification phase to lf4rcs
author bsw
date Fri Dec 04 14:25:43 2015 +0100 (2015-12-04)
parents e0235b3d19ee
children 84f6e17c7ceb
rev   line source
bsw@730 1 -- ========================================================================
bsw@813 2 -- MANDATORY (MUST BE CAREFULLY CHECKED AND PROPERLY SET!)
bsw@730 3 -- ========================================================================
bsw@525 4
bsw@813 5 -- Name of this instance, defaults to name of config file
bsw@813 6 -- ------------------------------------------------------------------------
bsw@813 7 config.instance_name = "Instance name"
bsw@813 8
bsw@813 9
bsw@731 10 -- Information about service provider (HTML)
bsw@730 11 -- ------------------------------------------------------------------------
bsw/jbe@0 12 config.app_service_provider = "Snake Oil<br/>10000 Berlin<br/>Germany"
bsw/jbe@0 13
bsw@813 14
bsw@1045 15 -- A HTML formatted text the user has to accept while registering
bsw@730 16 -- ------------------------------------------------------------------------
bsw@1045 17 config.use_terms = "<h1>Terms of Use</h1><p>Insert terms here</p>"
bsw@88 18
bsw@813 19
bsw@729 20 -- Checkbox(es) the user has to accept while registering
bsw@730 21 -- ------------------------------------------------------------------------
bsw@1222 22 --[[
bsw@79 23 config.use_terms_checkboxes = {
bsw@79 24 {
jbe@232 25 name = "terms_of_use_v1",
jbe@232 26 html = "I accept the terms of use.",
jbe@232 27 not_accepted_error = "You have to accept the terms of use to be able to register."
bsw@734 28 },
bsw@1222 29 {
bsw@1222 30 name = "extra_terms_of_use_v1",
bsw@1222 31 html = "I accept the extra terms of use.",
bsw@1222 32 not_accepted_error = "You have to accept the extra terms of use to be able to register."
bsw@1222 33 }
bsw@79 34 }
bsw@1222 35 --]]
bsw@735 36
bsw@813 37 -- Absolute base url of application
bsw@813 38 -- ------------------------------------------------------------------------
bsw@813 39 config.absolute_base_url = "http://example.com/"
bsw@1222 40 config.localhost = false
bsw@813 41
bsw@813 42
bsw@813 43 -- Connection information for the LiquidFeedback database
bsw@813 44 -- ------------------------------------------------------------------------
bsw@813 45 config.database = { engine='postgresql', dbname='liquid_feedback' }
bsw@813 46
bsw@813 47
bsw@735 48 -- Location of the rocketwiki binaries
bsw@735 49 -- ------------------------------------------------------------------------
bsw@1045 50 config.enforce_formatting_engine = "markdown2"
bsw@1045 51 config.formatting_engines = {
bsw@1045 52 { id = "markdown2",
bsw@1045 53 name = "python-markdown2",
bsw@1045 54 executable = "markdown2",
bsw@1052 55 args = {'-s', 'escape', '-x', 'nofollow,wiki-tables'},
bsw@1045 56 remove_images = true
bsw@1045 57 },
bsw@1170 58 -- { id = "markdown_py",
bsw@1170 59 -- name = "Python Markdown",
bsw@1170 60 -- executable = "markdown_py",
bsw@1170 61 -- args = {'-s', 'escape', '-x', 'extra', '-x', 'nl2br', '-x', 'sane_lists'},
bsw@1170 62 -- remove_images = true
bsw@1170 63 -- },
bsw@1170 64 -- { id = "rocketwiki",
bsw@1170 65 -- name = "RocketWiki",
bsw@1170 66 -- executable = "/opt/rocketwiki-lqfb/rocketwiki-lqfb"
bsw@1170 67 -- },
bsw@1170 68 -- { id = "compat",
bsw@1170 69 -- name = "Traditional WIKI syntax",
bsw@1170 70 -- executable = "/opt/rocketwiki-lqfb/rocketwiki-lqfb-compat"
bsw@1170 71 -- },
bsw@735 72 }
bsw@79 73
bsw/jbe@6 74
bsw@813 75 -- Public access level
bsw@734 76 -- ------------------------------------------------------------------------
bsw@813 77 -- Available options:
bsw@813 78 -- "none"
bsw@813 79 -- -> Closed user group, no public access at all
bsw@813 80 -- (except login/registration/password reset)
bsw@813 81 -- "anonymous"
bsw@813 82 -- -> Shows only initiative/suggestions texts and aggregated
bsw@813 83 -- supporter/voter counts
bsw@813 84 -- "authors_pseudonymous"
bsw@813 85 -- -> Like anonymous, but shows screen names of authors
bsw@813 86 -- "all_pseudonymous"
bsw@813 87 -- -> Show everything a member can see, except profile pages
bsw@813 88 -- "everything"
bsw@813 89 -- -> Show everything a member can see, including profile pages
bsw@813 90 -- ------------------------------------------------------------------------
bsw@813 91 config.public_access = "none"
bsw@734 92
bsw@737 93
bsw@732 94
bsw@737 95 -- ========================================================================
bsw@737 96 -- OPTIONAL
bsw@737 97 -- Remove leading -- to use a option
bsw@737 98 -- ========================================================================
bsw@731 99
bsw@1071 100 -- Disable registration
bsw@1071 101 -- ------------------------------------------------------------------------
bsw@1071 102 -- Available options:
bsw@1071 103 -- false: registration is enabled (default)
bsw@1071 104 -- true: registration is disabled
bsw@1071 105 -- ------------------------------------------------------------------------
bsw@1071 106 -- config.disable_registration = true
bsw@1071 107
bsw@1170 108
bsw@729 109 -- List of enabled languages, defaults to available languages
bsw@730 110 -- ------------------------------------------------------------------------
bsw@1129 111 -- config.enabled_languages = { 'en', 'de', 'eo', 'el', 'hu', 'it', 'ka', 'nl', 'zh-Hans', 'zh-TW' }
bsw@2 112
bsw@1170 113
bsw@729 114 -- Default language, defaults to "en"
bsw@730 115 -- ------------------------------------------------------------------------
bsw@729 116 -- config.default_lang = "en"
poelzi@163 117
bsw@1170 118
bsw@734 119 -- after how long is a user considered inactive and the trustee will see warning,
bsw@734 120 -- notation is according to postgresql intervals, default: no warning at all
bsw@730 121 -- ------------------------------------------------------------------------
bsw@729 122 -- config.delegation_warning_time = '6 months'
bsw/jbe@6 123
bsw@1170 124
bsw@988 125 -- after which time a user is advised (_soft) or forced (_hard) to check
bsw@988 126 -- unit and area delegations. default: no check at all
bsw@988 127 -- ------------------------------------------------------------------------
bsw@988 128 -- config.check_delegations_interval_hard = "6 months"
bsw@988 129 -- config.check_delegations_interval_soft = "3 months"
bsw@988 130
bsw@1170 131
bsw@988 132 -- default option when checking delegations
bsw@988 133 -- available options: "confirm", "revoke" and "none", default: "confirm"
bsw@988 134 -- ------------------------------------------------------------------------
bsw@988 135 -- config.check_delegations_default = "confirm"
bsw@988 136
bsw@1170 137
bsw@734 138 -- Prefix of all automatic mails, defaults to "[Liquid Feedback] "
bsw@730 139 -- ------------------------------------------------------------------------
bsw@729 140 -- config.mail_subject_prefix = "[LiquidFeedback] "
bsw@734 141
bsw@1170 142
bsw@734 143 -- Sender of all automatic mails, defaults to system defaults
bsw@734 144 -- ------------------------------------------------------------------------
bsw@839 145 -- config.mail_envelope_from = "liquidfeedback@example.com"
bsw@839 146 -- config.mail_from = { name = "LiquidFeedback", address = "liquidfeedback@example.com" }
bsw@839 147 -- config.mail_reply_to = { name = "Support", address = "support@example.com" }
bsw/jbe@6 148
bsw@1170 149
bsw@905 150 -- Configuration of password hashing algorithm (defaults to "crypt_sha512")
bsw@905 151 -- ------------------------------------------------------------------------
bsw@905 152 -- config.password_hash_algorithm = "crypt_sha512"
bsw@1206 153 -- config.password_hash_algorithm = "crypt_sha256"
bsw@905 154 -- config.password_hash_algorithm = "crypt_md5"
bsw@905 155
bsw@1170 156
bsw@905 157 -- Number of rounds for crypt_sha* algorithms, minimum and maximum
bsw@905 158 -- (defaults to minimum 10000 and maximum 20000)
bsw@905 159 -- ------------------------------------------------------------------------
bsw@905 160 -- config.password_hash_min_rounds = 10000
bsw@905 161 -- config.password_hash_max_rounds = 20000
bsw@905 162
bsw@905 163
bsw@729 164 -- Supply custom url for avatar/photo delivery
bsw@730 165 -- ------------------------------------------------------------------------
bsw@729 166 -- config.fastpath_url_func = nil
bsw@51 167
bsw@1170 168
bsw@729 169 -- Local directory for database dumps offered for download
bsw@730 170 -- ------------------------------------------------------------------------
bsw@729 171 -- config.download_dir = nil
bsw@51 172
bsw@1170 173
bsw@729 174 -- Special use terms for database dump download
bsw@730 175 -- ------------------------------------------------------------------------
bsw@729 176 -- config.download_use_terms = "=== Download use terms ===\n"
bsw/jbe@52 177
bsw@1170 178
bsw@734 179 -- Use custom image conversion, defaults to ImageMagick's convert
bsw@730 180 -- ------------------------------------------------------------------------
bsw@729 181 --config.member_image_content_type = "image/jpeg"
bsw@729 182 --config.member_image_convert_func = {
bsw@729 183 -- avatar = function(data) return extos.pfilter(data, "convert", "jpeg:-", "-thumbnail", "48x48", "jpeg:-") end,
bsw@729 184 -- photo = function(data) return extos.pfilter(data, "convert", "jpeg:-", "-thumbnail", "240x240", "jpeg:-") end
bsw@729 185 --}
bsw@51 186
bsw@1170 187
bsw@1045 188 -- Display a html formatted public message of the day
bsw@837 189 -- ------------------------------------------------------------------------
bsw@1045 190 -- config.motd_public = "<h1>Message of the day (public)</h1><p>The MOTD is formatted with HTML</p>"
bsw@1045 191
bsw@1170 192
bsw@1045 193 -- Display a html formatted internal message of the day
bsw@1045 194 -- ------------------------------------------------------------------------
bsw@1045 195 -- config.motd_intern = "<h1>Message of the day (intern)</h1><p>The MOTD is formatted with HTML</p>"
bsw@837 196
bsw@1170 197
bsw@734 198 -- Integration of Etherpad, disabled by default
bsw@730 199 -- ------------------------------------------------------------------------
bsw@729 200 --config.etherpad = {
bsw@729 201 -- base_url = "http://example.com:9001/",
bsw@729 202 -- api_base = "http://localhost:9001/",
bsw@729 203 -- api_key = "mysecretapikey",
bsw@729 204 -- group_id = "mygroupname",
bsw@729 205 -- cookie_path = "/"
bsw@729 206 --}
bsw@51 207
bsw@1170 208
bsw@961 209 -- Free timings
bsw@961 210 -- ------------------------------------------------------------------------
bsw@961 211 -- This example expects a date string entered in the free timing field
bsw@961 212 -- by the user creating a poll, interpreting it as target date for then
bsw@961 213 -- poll and splits the remaining time at the ratio of 4:1:2
bsw@961 214 -- Please note, polling policies never have an admission phase
bsw@961 215 -- The available_func is optional, if not set any target date is allowed
bsw@961 216
bsw@1222 217 --[[
bsw@961 218 config.free_timing = {
bsw@961 219 calculate_func = function(policy, timing_string)
bsw@1166 220 local function interval_by_seconds(secs)
bsw@961 221 local secs_per_day = 60 * 60 * 24
bsw@961 222 local days
bsw@961 223 days = math.floor(secs / secs_per_day)
bsw@961 224 secs = secs - days * secs_per_day
bsw@961 225 return days .. " days " .. secs .. " seconds"
bsw@961 226 end
bsw@961 227 local target_date = parse.date(timing_string, atom.date)
bsw@961 228 if not target_date then
bsw@961 229 return false
bsw@961 230 end
bsw@961 231 local target_timestamp = target_date.midday
bsw@961 232 local now = atom.timestamp:get_current()
bsw@961 233 trace.debug(target_timestamp, now)
bsw@961 234 local duration = target_timestamp - now
bsw@961 235 if duration < 0 then
bsw@961 236 return false
bsw@961 237 end
bsw@961 238 return {
bsw@961 239 discussion = interval_by_seconds(duration / 7 * 4),
bsw@961 240 verification = interval_by_seconds(duration / 7 * 1),
bsw@961 241 voting = interval_by_seconds(duration / 7 * 2)
bsw@961 242 }
bsw@961 243 end,
bsw@961 244 available_func = function(policy)
bsw@961 245 return {
bsw@961 246 { name = "End of 2013", id = '2013-12-31' },
bsw@961 247 { name = "End of 2014", id = '2014-12-31' },
bsw@961 248 { name = "End of 2015", id = '2015-12-31' }
bsw@961 249 }
bsw@961 250 end
bsw@961 251 }
bsw@1222 252 --]]
bsw@1170 253
bsw@1219 254 -- Configuration of lf4rcs
bsw@1219 255 -- ------------------------------------------------------------------------
bsw@1222 256 -- config.lf4rc = {}
bsw@1219 257
bsw@1219 258 -- Example configuration for controlling a Git repository
bsw@1222 259 --[[
bsw@1219 260 config.lf4rcs.git = {
bsw@1219 261
bsw@1219 262 render_draft_reference = function(url, draft)
bsw@1219 263 if not draft.external_reference then return end
bsw@1219 264 ui.tag{ content = _"Changeset:" }
bsw@1219 265 slot.put(" ")
bsw@1219 266 ui.link{
bsw@1219 267 text = draft.external_reference,
bsw@1219 268 external = url .. ";a=commit;h=" .. draft.external_reference
bsw@1219 269 }
bsw@1219 270 end,
bsw@1219 271
bsw@1219 272 get_remote_user = function()
bsw@1219 273 return os.getenv("REMOTE_USER")
bsw@1219 274 end,
bsw@1219 275
bsw@1219 276 get_branches = function(path, exec)
bsw@1219 277 local branches = {}
bsw@1219 278 for line in io.lines() do
bsw@1219 279 local oldrev, newrev, branch = string.match(line, "([^ ]+) ([^ ]+) refs/heads/(.+)")
bsw@1219 280 if not branch then
bsw@1219 281 return nil, "unexpected format from git hook environment"
bsw@1219 282 end
bsw@1219 283 branches[branch] = { newrev }
bsw@1219 284 end
bsw@1219 285 return branches
bsw@1219 286 end,
bsw@1219 287
bsw@1219 288 commit = function(path, exec, branch, target_node_id, close_message, merge_message)
bsw@1219 289 if merge_message then
jbe@1221 290 exec("git", "-C", path, "checkout", "-f", "master")
bsw@1219 291 exec("git", "-C", path, "merge", target_node_id, "-m", merge_message)
bsw@1219 292 exec("git", "-C", path, "push", "origin", "master")
bsw@1219 293 end
bsw@1219 294 end
bsw@1219 295
bsw@1219 296 }
bsw@1219 297
bsw@1219 298 -- Example configuration for controlling a Mercurial repository
bsw@1219 299 config.lf4rcs.hg = {
bsw@1219 300
bsw@1219 301 working_branch_name = "work",
bsw@1219 302
bsw@1219 303 render_draft_reference = function(url, draft)
bsw@1219 304 if not draft.external_reference then return end
bsw@1219 305 ui.tag{ content = _"Changeset graph:" }
bsw@1219 306 slot.put(" ")
bsw@1219 307 ui.link{
bsw@1219 308 text = draft.external_reference,
bsw@1219 309 external = url .. "/graph/" .. draft.external_reference
bsw@1219 310 }
bsw@1219 311 end,
bsw@1219 312
bsw@1219 313 get_remote_user = function()
bsw@1219 314 return os.getenv("REMOTE_USER")
bsw@1219 315 end,
bsw@1219 316
bsw@1219 317 get_branches = function(path, exec)
bsw@1219 318 local first_node_id = os.getenv("HG_NODE")
bsw@1219 319 if not first_node_id then
bsw@1219 320 return nil, "internal error, no first node ID available"
bsw@1219 321 end
bsw@1219 322 local hg_log = exec(
bsw@1219 323 "hg", "log", "-R", path, "-r", first_node_id .. ":", "--template", "{branches}\n"
bsw@1219 324 )
bsw@1219 325 local branches = {}
bsw@1219 326 for branch in hg_log:gmatch("(.-)\n") do
bsw@1219 327 if branch == "" then branch = "default" end
bsw@1219 328 if not branches[branch] then
bsw@1219 329 branches[branch] = {}
bsw@1219 330 local head_lines = exec(
bsw@1219 331 "hg", "heads", "-R", path, "--template", "{node}\n", branch
bsw@1219 332 )
bsw@1219 333 for node_id in string.gmatch(head_lines, "[^\n]+") do
bsw@1219 334 table.insert(branches[branch], node_id)
bsw@1219 335 end
bsw@1219 336 end
bsw@1219 337 end
bsw@1219 338 return branches
bsw@1219 339 end,
bsw@1219 340
bsw@1219 341 extra_checks = function(path, exec)
bsw@1219 342 local result = exec("hg", "heads", "-t", "-c")
bsw@1219 343 for branch in string.gmatch(result, "[^\n]+") do
bsw@1219 344 if branch == lf4rcs.config.hg.working_branch_name then
bsw@1219 345 return nil, "open head found for branch " .. lf4rcs.config.hg.working_branch_name
bsw@1219 346 end
bsw@1219 347 end
bsw@1219 348 return true
bsw@1219 349 end,
bsw@1219 350
bsw@1219 351 commit = function(path, exec, branch, target_node_id, close_message, merge_message)
bsw@1219 352 exec("hg", "up", "-R", path, "-C", "-r", target_node_id)
bsw@1219 353 exec("hg", "commit", "-R", path, "--close-branch", "-m", close_message)
bsw@1219 354 if merge_message then
bsw@1219 355 exec("hg", "up", "-R", path, "-C", "-r", "default")
bsw@1219 356 exec("hg", "merge", "-R", path, "-r", "tip")
bsw@1219 357 exec("hg", "commit", "-R", path, "-m", merge_message)
bsw@1219 358 end
bsw@1219 359 end
bsw@1219 360
bsw@1219 361 }
bsw@1219 362
bsw@1235 363 -- Grace period after creating an initiative for pushing changes during verification phase
bsw@1235 364 -- disabled by default (nil), use PostgreSQL interval notation
bsw@1235 365 -- config.lf4rcs.push_grace_period = nil
bsw@1235 366
bsw@1219 367 lf4rcs.init()
bsw@1222 368 --]]
bsw@1219 369
bsw@1209 370 -- External references
bsw@1209 371 -- ------------------------------------------------------------------------
bsw@1209 372 -- Rendering of external references
bsw@1209 373
bsw@1209 374 --[[
bsw@1209 375 config.render_external_reference = {
bsw@1209 376 draft = function(draft, wrapper)
bsw@1209 377 wrapper(function()
bsw@1209 378 ui.tag{ content = draft.external_reference)
bsw@1209 379 end)
bsw@1209 380 end,
bsw@1209 381 initiative = function(initiative, wrapper)
bsw@1209 382 wrapper(function()
bsw@1209 383 ui.tag{ content = initiative.external_reference)
bsw@1209 384 end)
bsw@1209 385 end
bsw@1209 386 end
bsw@1209 387 --]]
bsw@1209 388
bsw@1106 389 -- Admin logger
bsw@1106 390 -- ------------------------------------------------------------------------
bsw@1106 391 -- Logging administrative activities
bsw@1106 392 -- disabled by default
bsw@1106 393
bsw@1106 394 --[[
bsw@1106 395 config.admin_logger = function(params)
bsw@1106 396
bsw@1106 397 local adminid = app.session.member_id
bsw@1106 398 local adminname = app.session.member.name
bsw@1107 399 local url = params._webmcp_path
bsw@1106 400
bsw@1106 401 -- do something (e.g. calling 'logger' via extos.pfilter)
bsw@1106 402
bsw@1106 403 end
bsw@1106 404 --]]
bsw@1106 405
bsw@1106 406
bsw@1170 407 -- Network interface to bind to
bsw@1170 408 -- ------------------------------------------------------------------------
bsw@1170 409 -- Available options:
bsw@1170 410 -- true: bind to localhost (default)
bsw@1170 411 -- false: bind to all interface
bsw@1170 412 -- ------------------------------------------------------------------------
bsw@1170 413 -- config.localhost = true
bsw@1170 414
bsw@1170 415
bsw@1170 416 -- Network port to bind to
bsw@1170 417 -- ------------------------------------------------------------------------
bsw@1170 418 -- config.port = 8080
bsw@1170 419
bsw@1170 420
bsw@1170 421 -- Serving content via IPV6
bsw@1170 422 -- ------------------------------------------------------------------------
bsw@1170 423 -- Available options:
bsw@1170 424 -- nil or false: do not serve via IPv6 (default)
bsw@1170 425 -- true: serve via IPv6
bsw@1170 426 -- ------------------------------------------------------------------------
bsw@1170 427 -- config.ipv6 = false
bsw@1170 428
bsw@1170 429
bsw@1170 430 -- Application server fork configuration
bsw@1170 431 -- ------------------------------------------------------------------------
bsw@1170 432 -- config.fork = {
bsw@1170 433 -- pre = 2, -- desired number of spare (idle) processes
bsw@1170 434 -- min = 4, -- minimum number of processes
bsw@1170 435 -- max = 128, -- maximum number of processes (hard limit)
bsw@1170 436 -- delay = 0.125, -- delay (seconds) between creation of spare processes
bsw@1170 437 -- error_delay = 2, -- delay (seconds) before retry of failed process creation
bsw@1170 438 -- exit_delay = 2, -- delay (seconds) between destruction of excessive spare processes
bsw@1170 439 -- idle_timeout = 900, -- idle time (seconds) after a fork gets terminated (0 for no timeout)
bsw@1170 440 -- memory_limit = 0, -- maximum memory consumption (bytes) before process gets terminated
bsw@1170 441 -- min_requests = 50, -- minimum count of requests handled before fork is terminated
bsw@1170 442 -- max_requests = 100 -- maximum count of requests handled before fork is terminated
bsw@1170 443 -- }
bsw@1170 444
bsw@1170 445
bsw@1170 446 -- HTTP server options
bsw@1170 447 -- ------------------------------------------------------------------------
bsw@1170 448 -- http_options = {
bsw@1170 449 -- static_headers = {} -- string or table of static headers to be returned with every request
bsw@1170 450 -- request_header_size_limit = 1024*1024, -- maximum size of request body sent by client
bsw@1170 451 -- request_body_size_limit = 64*1024*1024, -- maximum size of request body sent by client
jbe@1198 452 -- idle_timeout = 65, -- maximum time until receiving the first byte of the request headera
jbe@1198 453 -- stall_timeout = 60, -- maximum time a client connection may be stalled
jbe@1198 454 -- request_header_timeout = 120, -- maximum time until receiving the remaining bytes of the request header
jbe@1198 455 -- response_timeout = 3600, -- time in which request body and response must be sent
bsw@1170 456 -- maximum_input_chunk_size = 16384 -- tweaks behavior of request-body parser
bsw@1170 457 -- minimum_output_chunk_size = 1024 -- chunk size for chunked-transfer-encoding
bsw@1170 458 -- }
bsw@1170 459
bsw@1170 460
bsw@729 461 -- WebMCP accelerator
jbe@1223 462 -- ------------------------------------------------------------------------
jbe@1223 463 -- uncomment the following line to use C implementations of chosen
jbe@1223 464 -- functions:
bsw@730 465 -- ------------------------------------------------------------------------
bsw@729 466 -- require 'webmcp_accelerator'
jbe@1223 467
bsw/jbe@0 468
bsw@868 469 -- Trace debug
bsw@1222 470 -- ------------------------------------------------------------------------
bsw@868 471 -- uncomment the following line to enable debug trace
jbe@1223 472 -- ------------------------------------------------------------------------
bsw@868 473 -- config.enable_debug_trace = true
bsw/jbe@0 474

Impressum / About Us