remove useless duplicate file
[mharc.git] / lib / config.sh.dist
1 ##-------------------------------------------------------------------------
2 ##  File:
3 ##      $Id: config.sh.dist,v 1.19 2003/08/09 18:04:08 ehood Exp $
4 ##  Description:
5 ##      This is the main configuration file for the web mail archiving
6 ##      system.  The syntax of this file follows a subset of the Bourne
7 ##      shell syntax.  The reason for the simplicity is so the Perl
8 ##      program can easily parse this file.  The shell scripts can
9 ##      just source this file directly.
10 ##
11 ##      Normal environment variables can be referenced when defining
12 ##      the value of a variable.
13 ##-------------------------------------------------------------------------
14
15 ##-------------------------------------------------------------------------
16 ##  Main variables to verify
17 ##-------------------------------------------------------------------------
18
19 # The SW_ROOT setting is the most important since other variables are
20 # based upon it.  It should be the pathname to the directory you installed
21 # mharc.
22 SW_ROOT=/home/mharc
23
24 # MHonArc library path: If MHonArc libraries are not in Perl's default
25 # search path, add it here.
26 MHONARC_LIB=
27
28 # Pathname to source mail spool file: Modify to reflect you system.
29 # The reference to LOGNAME is an environment variable normally defined
30 # by the system to represent the username.
31 #
32 #   NOTE: If your environment does not define LOGNAME, make sure
33 #         to replace the variable with an appropriate value.
34 #
35 ORGMAIL=/var/spool/mail/$LOGNAME
36
37 # Set to 1 if $ORGMAIL is pathname to a mail spool file.  Else set
38 # to 0.  This affects how locking is done in filter-spool
39 IS_MAIL_SPOOL=1
40
41 # Root URL to mail archives.  This variable should represent what
42 # root URL path will be for web browsers to access your archives.
43 # The *_URL variables below are, by default, based upon this variable.
44 #
45 #   NOTE: For portability, it is best to exclude the server name
46 #         portion of the URL and only the path component.
47 #
48 ROOT_URL=/archive
49
50 # Email address of administrator: Used in MKNMZ_RC.
51 ADMIN_ADDRESS=
52
53 ##-------------------------------------------------------------------------
54 ##  The variables after here can generally be left as-is, but you may
55 ##  want to to check if you want more granular customization.
56 ##-------------------------------------------------------------------------
57
58 # Pathname to lists.def.
59 LISTS_DEF_FILE=$SW_ROOT/lib/lists.def
60
61 # Pathname of procmailrc (generated from $LISTS_DEF_FILE)
62 PROCMAILRC=$SW_ROOT/procmailrc.mharc
63
64 # Pathname of directory containing logs
65 LOG_DIR=$SW_ROOT/log
66
67 # Pathname of directory containing CGI programs
68 CGI_DIR=$SW_ROOT/cgi-bin
69
70 # Pathname of directory containing raw mail archives.
71 MBOX_DIR=$SW_ROOT/mbox
72
73 # Pathname of directory containing HTML mail archives.
74 HTML_DIR=$SW_ROOT/html
75
76 # Directory containing informational pages about each list archive.
77 INFO_DIR=$SW_ROOT/info
78
79 # Pathname to directory containing list-specific MHonArc resource files.
80 MHA_RC_DIR=$SW_ROOT/lib/mrc
81
82 # Pathname to main MHonArc resource file.
83 MHA_RC=$SW_ROOT/lib/common.mrc
84
85 # Pathname of archive lists index page.  This page provides a list
86 # of all archives available.
87 ALL_LISTS_FILE=$HTML_DIR/lists.html
88
89 # Pathname of header template for archive lists index page.  The
90 # header template defines the markup that should occur before the
91 # all archive listing.
92 ALL_LISTS_HEADER=$HTML_DIR/.PNM.all-head
93
94 # Pathname of footer template for archive lists index page.  The
95 # footer template defines the markup that should occur after the
96 # all archive listing.
97 ALL_LISTS_FOOTER=$HTML_DIR/.PNM.all-foot
98
99 # Text label HTML strings for all-lists table.  These can be changed
100 # to fit a particular locale
101 ALL_LISTS_LABEL_NAME='Name'
102 ALL_LISTS_LABEL_INDEXES='Current Index'
103 ALL_LISTS_LABEL_LAST_UPDATED='Last Updated'
104 ALL_LISTS_LABEL_INFO='[info]'
105 ALL_LISTS_LABEL_DATE='[Date]'
106 ALL_LISTS_LABEL_THREADS='[Thread]'
107
108 # The date/time format for showing the Last Updated time of archives
109 # on all-lists page.  The format is what is supported by strftime.
110 ALL_LISTS_DATE_FORMAT='%Y-%m-%d %H:%M:%S'
111
112 # Pathname of header template for period index pages.
113 MAIN_HEADER=$HTML_DIR/.PNM.head
114
115 # Pathname of footer template for period index pages.
116 MAIN_FOOTER=$HTML_DIR/.PNM.foot
117
118 # SEARCH_CGI url should not have to be changed, but the namazu.cgi
119 # program will need to be copied to $SW_ROOT/cgi-bin directory.
120 SEARCH_CGI=$ROOT_URL/cgi-bin/namazu.cgi
121
122 # URL to mbox archives.  This should be a URL that would access the
123 # the filesystem location defined by MBOX_DIR.
124 MBOX_URL=$ROOT_URL/mbox
125
126 # URL to html archives.  This should be a URL that would access the
127 # the filesystem location defined by HTML_DIR.
128 HTML_URL=$ROOT_URL/html
129
130 # Base URL containing informational pages about each list archive.
131 # This should be a URL that would access the the filesystem location
132 # defined by INFO_DIR.
133 INFO_URL=$ROOT_URL/info
134
135 # URL providing list of all archives.  This URL would provide the
136 # user a listing of all the archives available.
137 ALL_LISTS_URL=$HTML_URL
138
139 # URL to CGI programs This should be a URL that would access the the
140 # filesystem location defined by CGI_DIR.
141 CGI_URL=$ROOT_URL/cgi-bin
142
143 # URL to period navigation CGI program
144 MNAV_CGI=$CGI_URL/mnav.cgi
145
146 # URL to raw message extraction CGI program
147 EXTRACT_CGI=$CGI_URL/extract-mesg.cgi
148
149 # URL to persistent message reference CGI program
150 MESG_CGI=$CGI_URL/mesg.cgi
151
152 # Pathname to procmail program.  If procmail is not in your normal
153 # search path, change this to the absolate pathname to the program.
154 PROCMAIL=/usr/bin/procmail
155
156 # Procmail search path for $PROCMAILRC.
157 PROCMAIL_PATH=$SW_ROOT/bin:/usr/local/bin:/bin:/usr/bin
158
159 # Pathname to formail program.  If formail is not in your normal
160 # search path, change this to the absolate pathname to the program.
161 FORMAIL=/usr/bin/formail
162
163 # Pathname to lockfile program.  If lockfile is not in your normal
164 # search path, change this to the absolate pathname to the program.
165 LOCKFILE=/usr/bin/lockfile
166
167 # Pathname to mknmz program.  If mknmz is not in your normal
168 # search path, change this to the absolate pathname to the program.
169 MKNMZ=/usr/bin/mknmz
170
171 # Pathname to resource file for mknmz
172 MKNMZ_RC=$SW_ROOT/cgi-bin/mknmzrc
173
174 # Directory containing templates for namazu
175 MKNMZ_TMPL_DIR=$SW_ROOT/cgi-bin/template
176
177 # Lock time out in seconds when processing $ORGMAIL: If the lock
178 # is older than specified time, then the lock will be removed by
179 # force.
180 #ORGMAIL_LOCK_TIMEOUT=3600
181
182 # Options to procmail: Uncomment and change as needed if you want
183 # define extra procmail variables
184 #PROCMAILVARS="VERBOSE=yes LOGABSTRACT=yes"
185
186 # Address to receive all unmatched messages.  If this variable
187 # is defined, the "catch" archive will be disabled and all
188 # messages that do not match an archive will be forward to $CATCH_ADDRESS.
189 #CATCH_ADDRESS=
190
191 # Name of the "catch" archive: Uncomment and change to desired
192 # value.  Note, value should start with a "." for searching to
193 # be automatically disabled.
194 #CATCH_ARCHIVE=.catch
195
196 # Disable catch archive: Uncomment and change value to 1 if you
197 # do not want a catch archive.  If CATCH_ADDRESS is defined, this
198 # variable has no effect.  However, if CATCH_ADDRESS is blank and
199 # you disable the catch archive, all unmatched messages will be quietly
200 # dropped.
201 #DISABLE_CATCH_ARCHIVE=0
202
203 # Age of mailbox file, in seconds, to be considered for processing:
204 # This value should have a value which properly reflects how often
205 # mail is processed.  Here, 86400 = 1 day.  Since the default template
206 # crontab settings have mail processed hourly, this should be a
207 # reasonable setting.  However, if you decrease the frequency of mail
208 # processing, you may need to increase MTIME_AGE.
209 MTIME_AGE=86400
210
211 # Maximum size, in bytes, of msgid cache for detecting duplicate
212 # messages.  The larger of volume of messages you process, that
213 # larger the cache size should be.  The default size of 16K will
214 # roughly cache that last 300 messages-ids.
215 #MSGID_CACHE_SIZE=16384
216
217 # Destination mailbox for final rule in $PROCMAILRC.
218 # It is OKAY for this to be /dev/null.  See mk-procmailrc manpage
219 # for more information.
220 #FINAL_MSG_DESTINATION=/dev/null
221
222 # Message header fields to determine date of a message.  Format same
223 # as the DATEFIELDS resource of MHonArc.  This variable is used
224 # be extract-mesg-date and is passed into MHonArc via the DATEFIELDS
225 # resource.
226 #MSG_DATE_FIELDS='received:delivery-date:date'