diff --git a/majordomo/create_list.config b/majordomo/create_list.config new file mode 100644 index 000000000..3777bee06 --- /dev/null +++ b/majordomo/create_list.config @@ -0,0 +1,388 @@ +# The DEFAULT webmin configuration file for a majordomo mailing list. +# Comments start with the first # on a line, and continue to the end +# of the line. There is no way to escape the # character. The file +# uses either a key = value for simple (i.e. a single) values, or uses +# a here document +# key << END +# value 1 +# value 2 +# [ more values 1 per line] +# END +# for installing multiple values in array types. Note that the here +# document delimiter (END in the example above) must be the same at the end +# of the list of entries as it is after the << characters. +# Within a here document, the # sign is NOT a comment character. +# A blank line is allowed only as the last line in the here document. +# +# The values can have multiple forms: +# +# absolute_dir -- A root anchored (i.e begins with a /) directory +# absolute_file -- A root anchored (i.e begins with a /) file +# bool -- choose from: yes, no, y, n +# enum -- One of a list of possible values +# integer -- an integer (string made up of the digits 0-9, +# no decimal point) +# float -- a floating point number with decimal point. +# regexp -- A perl style regular expression with +# leading and trailing /'s. +# restrict_post -- a series of space or : separated file names in which +# to look up the senders address +# (restrict-post should go away to be replaced by an +# array of files) +# string -- any text up until a \n stripped of +# leading and trailing whitespace +# word -- any text with no embedded whitespace +# +# A blank value is also accepted, and will undefine the corresponding keyword. +# The character Control-A may not be used in the file. +# +# A trailing _array on any of the above types means that that keyword +# will allow more than one value. +# +# Within a here document for a string_array, the '-' sign takes on a special +# significance. +# +# To embed a blank line in the here document, put a '-' as the first +# and ONLY character on the line. +# +# To preserve whitespace at the beginning of a line, put a - on the +# line before the whitespace to be preserved +# +# To put a literal '-' at the beginning of a line, double it. +# +# +# The default if the keyword is not supplied is given in ()'s while the +# type of value is given in [], the subsystem the keyword is used in is +# listed in <>'s. (undef) as default value means that the keyword is not +# defined or used. + + # admin_passwd [word] (admin.admin) + # The password for handling administrative tasks on the list. +admin_passwd = + + # administrivia [bool] (yes) + # Look for administrative requests (e.g. subscribe/unsubscribe) and + # forward them to the list maintainer instead of the list. +administrivia = no + + # advertise [regexp_array] (undef) + # If the requestor email address matches one of these regexps, then + # the list will be listed in the output of a lists command. Failure + # to match any regexp excludes the list from the output. The + # regexps under noadvertise override these regexps. +advertise << END + +END + + # announcements [bool] (yes) + # If set to yes, comings and goings to the list will be sent to the + # list owner. These SUBSCRIBE/UNSUBSCRIBE event announcements are + # informational only (no action is required), although it is highly + # recommended that they be monitored to watch for list abuse. +announcements = yes + + # approve_passwd [word] (admin.pass) + # Password to be used in the approved header to allow posting to + # moderated list, or to bypass resend checks. +approve_passwd = + + # archive_dir [absolute_dir] (undef) + # The directory where the mailing list archive is kept. This item + # does not currently work. Leave it blank. +archive_dir = + + # comments [string_array] (undef) + # Comment string that will be retained across config file rewrites. +comments << END + +END + + # date_info [bool] (yes) + # Put the last updated date for the info file at the top of the + # info file rather than having it appended with an info command. + # This is useful if the file is being looked at by some means other + # than majordomo (e.g. finger). +date_info = yes + + # date_intro [bool] (yes) + # Put the last updated date for the intro file at the top of the + # intro file rather than having it appended with an intro command. + # This is useful if the file is being looked at by some means other + # than majordomo (e.g. finger). +date_intro = yes + + # debug [bool] (no) + # Don't actually forward message, just go though the motions. +debug = no + + # description [string] (undef) + # Used as description for mailing list when replying to the lists + # command. There is no quoting mechanism, and there is only room + # for 50 or so characters. +description = + + # digest_archive [absolute_dir] (undef) + # The directory where the digest archive is kept. This item does + # not currently work. Leave it blank. +digest_archive = + + # digest_issue [integer] (1) + # The issue number of the next issue +digest_issue = 1 + + # digest_maxdays [integer] (undef) + # automatically generate a new digest when the age of the oldest + # article in the queue exceeds this number of days. +digest_maxdays = + + # digest_maxlines [integer] (undef) + # automatically generate a new digest when the size of the digest + # exceeds this number of lines. +digest_maxlines = + + # digest_name [string] (admin) + # The subject line for the digest. This string has the volume and + # issue appended to it. +digest_name = + + # digest_rm_footer [word] (undef) + # The value is the name of the list that applies the header and + # footers to the messages that are received by digest. This allows + # the list supplied headers and footers to be stripped before the + # messages are included in the digest. +digest_rm_footer = + + # digest_rm_fronter [word] (undef) + # Works just like digest_rm_footer, except it removes the front + # material. +digest_rm_fronter = + + # digest_volume [integer] (1) + # The current volume number +digest_volume = 1 + + # digest_work_dir [absolute_dir] (undef) + # The directory used as scratch space for digest. Don't change + # this unless you know what you are doing +digest_work_dir = + + # get_access [enum] (list) /open;closed;list/ + # One of three values: open, list, closed. Open allows anyone + # access to this command and closed completely disables the command + # for everyone. List allows only list members access, or if + # restrict_post is defined, only the addresses in those files are + # allowed access. +get_access = list + + # index_access [enum] (open) /open;closed;list/ + # One of three values: open, list, closed. Open allows anyone + # access to this command and closed completely disables the command + # for everyone. List allows only list members access, or if + # restrict_post is defined, only the addresses in those files are + # allowed access. +index_access = open + + # info_access [enum] (open) /open;closed;list/ + # One of three values: open, list, closed. Open allows anyone + # access to this command and closed completely disables the command + # for everyone. List allows only list members access, or if + # restrict_post is defined, only the addresses in those files are + # allowed access. +info_access = open + + # intro_access [enum] (list) /open;closed;list/ + # One of three values: open, list, closed. Open allows anyone + # access to this command and closed completely disables the command + # for everyone. List allows only list members access, or if + # restrict_post is defined, only the addresses in those files are + # allowed access. +intro_access = list + + # maxlength [integer] (40000) + # The maximum size of an unapproved message in characters. When + # used with digest, a new digest will be automatically generated if + # the size of the digest exceeds this number of characters. +maxlength = 40000 + + # message_footer [string_array] (undef) + # Text to be appended at the end of all messages posted to the + # list. The text is expanded before being used. The following + # expansion tokens are defined: $LIST - the name of the current + # list, $SENDER - the sender as taken from the from line, $VERSION, + # the version of majordomo. If used in a digest, no expansion + # tokens are provided +message_footer << END + +END + + # message_fronter [string_array] (undef) + # Text to be prepended to the beginning of all messages posted to + # the list. The text is expanded before being used. The following + # expansion tokens are defined: $LIST - the name of the current + # list, $SENDER - the sender as taken from the from line, $VERSION, + # the version of majordomo. If used in a digest, only the expansion + # token _SUBJECTS_ is available, and it expands to the list of + # message subjects in the digest +message_fronter << END + +END + + # message_headers [string_array] (undef) + # These headers will be appended to the headers of the posted + # message. The text is expanded before being used. The following + # expansion tokens are defined: $LIST - the name of the current + # list, $SENDER - the sender as taken from the from line, $VERSION, + # the version of majordomo. +message_headers << END + +END + + # moderate [bool] (no) + # If yes, all postings to the list will be bounced to the moderator + # for approval. +moderate = no + + # moderator [word] (undef) + # Address for directing posts which require approval. Such + # approvals might include moderated mail, administrivia traps, and + # restrict_post authorizations. If the moderator address is not + # set, it will default to the list-approval address. +moderator = + + # mungedomain [bool] (no) + # If set to yes, a different method is used to determine a matching + # address. When set to yes, addresses of the form user@dom.ain.com + # are considered equivalent to addresses of the form user@ain.com. + # This allows a user to subscribe to a list using the domain + # address rather than the address assigned to a particular machine + # in the domain. This keyword affects the interpretation of + # addresses for subscribe, unsubscribe, and all private options. +mungedomain = no + + # noadvertise [regexp_array] (undef) + # If the requestor name matches one of these regexps, then the list + # will not be listed in the output of a lists command. Noadvertise + # overrides advertise. +noadvertise << END + +END + + # precedence [word] (bulk) + # Put a precedence header with value into the outgoing + # message. +precedence = bulk + + # purge_received [bool] (no) + # Remove all received lines before resending the message. +purge_received = no + + # reply_to [word] () + # Put a reply-to header with value into the outgoing + # message. If the token $SENDER is used, then the address of the + # sender is used as the value of the reply-to header. This is the + # value of the reply-to header for digest lists. +reply_to = + + # resend_host [word] (undef) + # The host name that is appended to all address strings specified + # for resend. +resend_host = + + # restrict_post [restrict_post] (undef) + # If defined, only addresses listed in these files (colon or space + # separated) can post to the mailing list. By default, these files + # are relative to the lists directory. These files are also checked + # when get_access, index_access, info_access, intro_access, + # which_access, or who_access is set to 'list'. This is less useful + # than it seems it should be since there is no way to create these + # files if you do not have access to the machine running resend. + # This mechanism will be replaced in a future version of + # majordomo/resend. +restrict_post = + + # sender [word] (owner-admin) + # The envelope and sender address for the resent mail. This string + # has "@" and the value of resend_host appended to it to make a + # complete address. For majordomo, it provides the sender address + # for the welcome mail message generated as part of the subscribe + # command. +sender = + + # strip [bool] (yes) + # When adding address to the list, strip off all comments etc, and + # put just the raw address in the list file. In addition to the + # keyword, if the file .strip exists, it is the same as + # specifying a yes value. That yes value is overridden by the value + # of this keyword. +strip = yes + + # subject_prefix [word] (undef) + # This word will be prefixed to the subject line, if it is not + # already in the subject. The text is expanded before being used. + # The following expansion tokens are defined: $LIST - the name of + # the current list, $SENDER - the sender as taken from the from + # line, $VERSION, the version of majordomo. +subject_prefix = + + # subscribe_policy [enum] (open+confirm) /open;closed + # One of three values: open, closed, auto; plus an optional + # modifier: '+confirm'. Open allows people to subscribe themselves + # to the list. Auto allows anybody to subscribe anybody to the list + # without maintainer approval. Closed requires maintainer approval + # for all subscribe requests to the list. Adding '+confirm', ie, + # 'open+confirm', will cause majordomo to send a reply back to the + # subscriber which includes a authentication number which must be + # sent back in with another subscribe command. +subscribe_policy = open + + # taboo_body [regexp_array] (undef) + # If any line of the body matches one of these regexps, then the + # message will be bounced for review. +taboo_body << END + +END + + # taboo_headers [regexp_array] (undef) + # If any of the headers matches one of these regexps, then the + # message will be bounced for review. +taboo_headers << END + +END + + # unsubscribe_policy [enum] (open) /open;closed;auto;op + # One of three values: open, closed, auto; plus an optional + # modifier: '+confirm'. Open allows people to unsubscribe + # themselves from the list. Auto allows anybody to unsubscribe + # anybody to the list without maintainer approval. The existence of + # the file .auto is the same as specifying the value + # auto. Closed requires maintainer approval for all unsubscribe + # requests to the list. In addition to the keyword, if the file + # .closed exists, it is the same as specifying the value + # closed. Adding '+confirm', ie, 'auto+confirm', will cause + # majordomo to send a reply back to the subscriber if the request + # didn't come from the subscriber. The reply includes a + # authentication number which must be sent back in with another + # subscribe command. The value of this keyword overrides the value + # supplied by any existent files. +unsubscribe_policy = auto + + # welcome [bool] (yes) + # If set to yes, a welcome message (and optional 'intro' file) will + # be sent to the newly subscribed user. +welcome = yes + + # which_access [enum] (open) /open;closed;list/ + # One of three values: open, list, closed. Open allows anyone + # access to this command and closed completely disables the command + # for everyone. List allows only list members access, or if + # restrict_post is defined, only the addresses in those files are + # allowed access. +which_access = open + + # who_access [enum] (open) /open;closed;list/ + # One of three values: open, list, closed. Open allows anyone + # access to this command and closed completely disables the command + # for everyone. List allows only list members access, or if + # restrict_post is defined, only the addresses in those files are + # allowed access. +who_access = open