scripts/mir-setup/README: update with link to new doc on wiki
[mir.git] / scripts / mir-setup / README
1 $Id: README,v 1.1.2.2 2009/01/18 04:28:49 ianb Exp $
2
3 The mir-setup script was developed initially on pulp (the
4 UK development server) and then on traven. It hasn't been
5 extensively tested outside of those environments, but is
6 here in the hope that it is useful.
7
8 See https://docs.indymedia.org/view/Sysadmin/TravenMirInstall
9 and https://docs.indymedia.org/Devel/MirOnDebianSqueeze
10 for more information on setting up sites with this script.
11
12 The files in this directory should be installed as follows:
13
14 mir/scripts/mir-setup/
15   mir-setup              ->   /usr/local/sbin/
16   munge_config_file.pl   ->   /usr/local/share/mir-setup/
17   conf/*                 ->   /etc/mir-setup/
18
19 If you choose different locations (for example running the
20 script direct from the CVS checkout, you'll need to modify CONFDIR
21 (in mir-setup itself) and/or SHAREDIR (in conf/config) accordingly.
22
23 If you run ./mir-prepare direct from the mir/scripts/mir-setup/
24 directory of the source tree, it will install and configure apache,
25 java, tomcat, etc. ready for you to set up sites with mir-setup. It
26 will also install mir-setup as detailed above.
27
28 mir-prepare and the config files in conf/ assume you are using tomcat5.5.
29 If you are still using tomcat4, use the config files in conf/tomcat4,
30 and beware that mir-prepare may need changes. mir-setup should
31 still work with tomcat4.
32
33 Note that this script has only been used with the MIR_1_1 branch so
34 far.