wiki:LancelotConfiguration

Lancelot List Configuration Parameters

This file documents some Lancelot list configuration parameters. (Use the source, Luke, for the complete list.)

Ground Rules

Parameter values consist of everything after the equals sign, with leading and trailing spaces removed.

There is no notion of "valid" parameter names; you may put anything you like in the database (and write a program to use it).

Global Parameters

lancelot.templatedirs

This parameter gives a global (space-separated) list of directories that will be searched for Lancelot templates. The language code (as per list.language, or en if list.language is unset) will be appended to each of the directories in the list, and the template will be looked for in the resulting directory.

In addition to these directories, Lancelot always searches the .ll/list@domain/templates and .ll/templates directories within the list owner's home directory.

lancelot.templatedirs = /etc/lancelot/templates

List Parameters

These parameters give information about a list as a whole.

list.address

This parameter gives the list address, as list@domain. This is the address that is used to submit messages to the list. The local MTA must be suitably configured so the list@domain and list-SOMETHING@domain addresses are forwarded to the ll-incoming(1) command.

list.address = test@example.com

list.name

This is the list's name, such as "Test". This will be used in messages from the list software to subscribers. Do not call a list "Foo List", use just "Foo".

list.name = Test

list.language

The language used for communication between Lancelot and the list users. This determines the templates to be used.

Lancelot comes with templates for English and German. Feel free to contribute additional templates, which should go in a directory that is named after the list.language value to be used for them.

Note that this has nothing to do with the language(s) that the list users use to converse among one another.

list.language = en

list.ownername

The list administrator's name. This can be left unset, in which case Lancelot will insert "the list owner" (in the appropriate language) in its place.

list.ownername = John Doe

list.owneraddress

The list administrator's mail address. Lancelot forwards mail to the list-owner@domain address to this address.

list.owneraddress = jdoe@example.com

list.addressdb

This parameter determines where Lancelot stores and retrieves subscriber information. Right now the only admissible value is sqlite:, which means "in the list's configuration database". Feel free to implement other approaches, such as ldap:/path/to/config/file; you will need to refer to the source:trunk/lib/Lancelot/DB.pm file to find out details.

list.addressdb = sqlite:

Incoming Mail

The following parameters deal with the processing of incoming mail, by ll-incoming(1) and various processing modules.

mail.workflow.submit

Gives a workflow for handling messages to the list@domain address.

mail.workflow.submit = policy_addresses policy_mime list_headers post_message

mail.workflow.subscribe

Gives a workflow for handling messages to the list-subscribe@domain address.

mail.workflow.subscribe = forward

mail.workflow.unsubscribe

Gives a workflow for handling messages to the list-unsubscribe@domain address.

mail.workflow.unsubscribe = forward

mail.workflow.help

Gives a workflow for handling messages to the list-help@domain address.

mail.workflow.help = send_help

mail.workflow.owner

Gives a workflow for handling messages to the list-owner@domain address.

mail.workflow.owner = forward

mail.policy.explicitaddress

If set to 1, requires the list@domain address to occur within the "To:" or "Cc:" headers of a message submitted for distribution. This is a spam prevention policy.

mail.policy.explicitaddress = 1

mail.policy.subscribersonly

If set to 1, only mail from subscribers is allowed for distribution. Other messages are silently discarded (this may change when message moderation is implemented).

mail.policy.subscribersonly = 1

mail.listheaders

If set to 1, RFC-2369 headers are added to outgoing messages.

mail.listheaders = 1

mail.subjecttag

If set, the value of this parameter is prepended to outgoing messages' "Subject:" headers.

mail.subjecttag =

mail.replyto

If set, the value of this parameter is used as the "Reply-To:" header on outgoing messages that do not already have one.

mail.replyto =

mail.forcereplyto

If set to 1, the value of the mail.replyto parameter is also used to replace the "Reply-To:" header on outgoing messages that do have one already. It is highly contentious whether this is a good idea.

mail.forcereplyto = 0

SMTP Configuration

Lancelot uses an SMTP server to send mail, both for list distribution and for communicating with individual users. The following parameters determine how Lancelot converses with the SMTP server.

smtp.server

The SMTP server.

Forwarding Messages

The forward processing module is used to forward messages to other addresses (usually the list administrator's).

forward.notice

This parameter is used to internationalise the string added as the main explanatory MIME part when Lancelot forwards a message using the forward processing module. Its value should include a %s key, which will be replaced by the list name from list.name.

forward.notice = This just came in on the %s list.
Last modified 13 years ago Last modified on Mar 1, 2005, 2:39:03 PM