gitweb/indextext_readonly.html: include sample readonly file
[girocco.git] / INSTALL
blob81f6e1103ecfa0544aa0f9b8aad683c964e5b63a
1 FIRST, you need to configure Girocco:
2    * Edit Girocco/Config.pm
3    * Alternatively to the above, copy over to and edit Girocco/Config2.pm and  
4      run `make` and `make install` with GIROCCO_CONF=Girocco::Config2 or with  
5      `echo GIROCCO_CONF=Girocco::Config2 >> config.sh`
7 Make sure you have the submodules checked out:
9         git submodule update --init
11 THEN, do
13         make
15 which will do some preprocessing in theory.
16 Now, you can do the installation itself:
18         make install
20 will then install Girocco according to Girocco::Config (you might need to be
21 root, depending on the exact settings).  Note that GNU make is required.  If
22 "make" is not GNU make then GNU make needs to be available as "gmake".
24 If you use the mirror mode or want to use the push notifications, you must
25 make sure taskd.pl is kept running.
27 At any rate, you will need to periodically call jobd maintenance job that
28 will refresh mirrored repositories, but also repack all repositories. You
29 can either just keep jobd.pl running (good if you have large amount
30 of repositories), or add a special invocation (advised by make install)
31 to your crontab.
33 The cron, fstab, rsyslog, screen and xinetd directories contain README files
34 and sample configuration files to help configure the system for Girocco.
36 Girocco is reasonably self-sufficient, but does depend on a few external
37 programs and libraries:
39 - darcs, if you want to handle darcs+http:// and darcs+https:// mirroring
40 - python-chardet, if you want to handle non-utf8 darcs imports
41 - bzr, if you want to handle bzr:// mirroring
42 - hg, if you want to handle hg+http:// and hg+https:// mirroring