root/doc/config.txt

# = Project Lancelot List Configuration Parameters =
#
# This file documents all Project Lancelot list configuration
# parameters. It can serve as the basis for a Project Lancelot list
# configuration; just change it and read it using
# "pl-conf --import <config.txt".
#
# == 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 Project 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, Project Lancelot always searches the
# ''.pl/list@domain/templates'' and ''.pl/templates'' directories within
# the list owner's home directory.

lancelot.templatedirs = /etc/lancelot/templates

# === lancelot.mailer ===

# == 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 pl-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 Project Lancelot and the
# list users. This determines the templates to be used.
#
# Project 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 Project 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. Project Lancelot forwards mail to
# the ''list''-owner''@domain'' address to this address.

list.owneraddress = jdoe@example.com

# === list.addressdb ===
#
# This parameter determines where Project 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:

# === list.confirmdelay ===
# === list.timeformat ===

# == Incoming Mail ==
#
# The following parameters deal with the processing of incoming mail,
# by pl-incoming(1) and various processing modules.
#
# === mail.delimiter ===
# === mail.trace ===
#
# === 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.listid ===

# === mail.removeheaders ===
# === mail.addheaders ===
# === mail.header.X ===

# === 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 ==
#
# Project Lancelot uses an SMTP server to send mail, both for list
# distribution and for communicating with individual users. The
# following parameters determine how Project Lancelot converses with
# the SMTP server.
#
# === smtp.server ===
#
# The SMTP server.

# === smtp.port ===
# === smtp.timeout ===
# === smtp.maxrecipients ===
# === smtp.verp ===
# === smtp.debug ===

# == 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 Project 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.

# == Subscribing and Unsubscribing ==
#
# === subscribe.type ===
# === subscribe.confirm ===
# === subscribe.confirmdefault ===
# === subscribe.digestdefault ===
# === subscribe.nomaildefault ===
# === subscribe.moderateddefault ===
# === subscribe.welcome ===
# === subscribe.notices ===
#
# === unsubscribe.confirm ===
# === unsubscribe.goodbye ===
# === unsubscribe.notices ===

# == Configuration ==
#
# === config.digest ===
# === config.nomail ===
# === config.name ===

# == Archive ==
#
# The '''archive_store''' processing module helps maintain an archive
# of past postings to the mailing list.
#
# === archive.directory ===
#
# This parameter gives the directory in which the archive is
# kept. Inside this directory, there will be one subdirectory for
# every 100 postings to the mailing list, containing one file per
# archived message. The name of this subdirectory is the integer part
# of the message number divided by 100, while the name of the file
# itself is the remainder of the message number divided by 100. In
# other words, message 12345 would be stored in the file ''123/45''
# inside the archive directory.
#
# The value of this parameter is taken relative to the list directory
# if it does not start with a slash ('''/''').

archive.directory = archive

# === archive.dirmode ===
#
# This parameter specifies the permissions for the
# '''archive.directory''' (and its subdirectories). This only applies
# when new directories are being created. The value is an octal number
# with the customary Unix meaning (refer to '''chmod(1)''').

archive.dirmode = 0755

# === archive.url ===
# === archive.lurker.name ===
# === archive.lurker.command ===

# == Digests ==
#
# === digest.name ===
# === digest.maxperiod ===
# === digest.minsize ===
# === digest.maxsize ===
# === digest.type ===
# === digest.volume ===
# === digest.headers ===
# === digest.type.plain.headers ===
# === digest.type.mime.headers ===

# == Bounce Handling ==
#
# === bounce.bucketcount ===
# === bounce.bucketsize ===
# === bounce.threshold ===
# === bounce.warnings ===
# === bounce.warnperiod ===
# === bounce.score.hard ===
# === bounce.score.soft ===
# === bounce.unknownaction ===

# == Authentication ==
#
# === auth.gpg.keyring ===

# == Moderation ==
#
# === mod.enable ===
# === mod.quorum.approve ===
# === mod.quorum.reject ===
# === mod.quorum.discard ===
# === mod.timeout ===
# === mod.disposal ===
# === mod.notifylines ===

# == Remote Administration by mail ==
#
# === admin.list.defaultorder ===
# === admin.allowed ===
# === admin.setconfig.allow ===
# === admin.setconfig.refuse ===