6 See the Upgrading section at the end for changes that might affect users
8 ==========================
10 SECURITY WARNING: Do not put hypermail's output anyplace where a web
11 server might have server side includes (SSI) enabled, unless you are sure
12 you know what you are doing. If in doubt, check your web server
13 configuration. If you are using Apache, look for an Options line
14 that mentions Includes or IncludesNOEXEC. The author of an email
15 normally has substantial control over what files hypermail creates,
16 particularly via attachments. Hypermail is designed to insure that
17 filenames don't end in .shtml and don't contain characters like / or \,
18 which prevent some security problems, but there are few restrictions
19 on what can go in a file (e.g. possibly malicious html tags - try the
20 "text_types = *" option or "ignore_types = $NONPLAIN" option if you want
21 to restrict this). You might also want to look at the attachmentlink
22 and unsafe_chars options to restrict attachment filenames.
23 Also, it is probably a bad idea to enable cgi execution on a directory
24 that hypermail puts files in.
25 Do not use the crappy cgi program called "mail".
27 Before Building Hypermail:
28 ==========================
30 Hypermail now uses "configure" to generate the Makefiles. In the
31 top level directory, type "configure" to create the Makefiles.
32 If it does not work on your system, please let me know.
37 Hypermail has been normally compiled and run on Unix-based systems
38 in the past. Today it can be configured and built using Cygwin
39 software. I have either compiled and tested this code successfully
40 on the following platforms or others have told me of their success.
42 Solaris, SunOS 4.1.3, FreeBSD 2.2.5 and later,
43 BSDI/3.x, Linux kernel 2.0.18 and 2.0.30, Redhat 5.x and later,
44 NT using CygWin-b19 <http://www.cygnus.com/misc/gnu-win32>,
45 Irix6.2, HP-UX 10.20 and later, SCO OS 5.0.5, and TRU64/OSF1
48 Hypermail compiles on MacOSX, tested with X.2.6. Beware that
49 you may need to configure it to use --disable-shared and manually
50 execute make in src/pcre before.
52 For more information on Cygwin and build hypermail on a Windows-based
53 system, see the file docs/Install-win32.txt.
57 1) Type "./configure". This creates the makefiles and the
58 config.h file needed to build the software.
59 If you want to install Hypermail somewhere other than in /usr/local,
60 run something like this instead: ./configure --prefix=$HOME
62 2) Type "make". This will build the software.
63 If it has trouble finding gdbm (e.g. if it fails with a message such as
64 "cannot open -lgdbm", you may need to disable gdbm with:
66 ./configure --without-gdbm
68 and type "make clean" and then "make" again. (Note that without gdbm,
69 you can't do incremental updates using the folder_by_date option).
71 On some systems you may need to add "-R/usr/local/lib -L/usr/local/lib"
72 to the CFLAGS variable in the Makefiles, or alter your LD_LIBRARY_PATH
73 environment variable (Willi Kernen reports that on a 64-bit Solaris,
74 changing LD_LIBRARY_PATH to:
76 /usr/lib:/usr/local/lib:/usr/ccs/lib:/usr/ucb/lib:/usr/openwin/lib
80 If the make fails at this line:
82 ar cq libpcre.a maketables.o get.o study.o pcre.o
84 and the configure had said:
86 checking whether to build static libraries... no
88 then you probably should try:
90 ./configure --disable-shared
92 If the make fails with a message such as:
94 proto.h:99: conflicting types for `strcasestr'
95 /usr/include/string.h:86: previous declaration of `strcasestr'
97 then you should try removing the line in proto.h that refers to strcasestr.
102 If you wish to test the new hypermail before installing it
106 - copy a mailbox you have to a local file named "testmail"
110 This will generate an archive under a newly created "testdir/"
111 directory. Check it out with your favorite browser.
113 When you are done testing,
115 - remove the testdir directory,
117 - remove the testmail file.
119 (See the README in tests/ for more information.)
121 Installing Hypermail:
122 =====================
124 You may need to login as root for this step.
125 To install just the Hypermail programs:
127 - chdir to the src/ directory
129 - Type "make install". (Or, if you prefer, just copy "hypermail" to
130 wherever you want it).
132 If you want a full install of Hypermail and its documentation, do
136 in the main Hypermail directory (the one where you did ./configure).
137 If it fails with something like:
138 mkdir: "/usr/local/apache/htdocs/hypermail": Permission denied
139 then you may need to rerun ./configure giving it the directory in
140 which you want to install html documentation files using this option:
141 --with-htmldir=/var/www/htdocs
145 The body option has been disabled as of version 2.1.4 for strict
146 HTML 4.01 compatibility. You should replace any body command you
147 have in your .hmrc with a style sheet (such as a file called
148 hypermail.css in the archive directory), and set icss_url and
149 mcss_url to the url of that style sheet. If you want the appearance
150 that was the default before 2.1.4, your style sheet should contain this:
152 body {color: black; background: #ffffff}
153 h1.center {text-align: center}
154 div.center {text-align: center}
156 Also, if you have been using the icss_url and/or mcss_url options and
157 are upgrading to 2.1.4 or higher, you might want to add those statements
158 to your style sheet, as their style is no longer being provided by
159 <body ...> tags, etc. (For users not specifying an icss_url and mcss_url,
160 default style sheets have been put in all files to maintain that style.)
162 The overwrite option defaulted to On for many versions. Starting with
163 version 2.1.4, it defaults to off again. You may want to turn it on
164 again occasionally to insure that all of your archive uses the same style
165 (assuming you have a copy of the archive in mbox format).
168 The cgi program called "mail" has been disabled. If you've been
169 using it, you should either stop using it or look carefully enough
170 at what it does to understand whether it is safe for you to enable
171 its functionality. This could be a security concern for your site.