tools/cgi/README.in

   1 darcs.cgi is the darcs repository viewer.  It provides a web interface
   2 for viewing darcs repositories, using XSLT to transform darcs' XML
   3 output into XHTML. It is written in perl and is more featureful than
   4 the older haskell cgi program darcs_cgi.lhs (seen in URLs as "darcs").
   5
   6 dependencies
   7
   8   darcs.cgi requires with the following tools and has been tested with
   9   the version mentioned:
  10
  11   darcs-1.0.1           http://www.darcs.net
  12   libxslt-1.1.6         http://xmlsoft.org/XSLT/
  13   perl-5.8.0            http://www.perl.com
  14
  15 installation
  16
  17   1) copy darcs.cgi to your webserver's cgi directory, eg
  18      /usr/lib/cgi-bin. A symlink probably won't do. Make
  19      sure it's executable.
  20   2) copy cgi.conf to @sysconfdir@/darcs/cgi.conf and edit appropriately.
  21      You can overwrite the cgi.conf used by the old darcs cgi script.
  22      You probably don't need to change anything here.
  23   3) copy the xslt directory to @datadir@/darcs/xslt
  24   4) copy xslt/styles.css to @sysconfdir@/darcs/styles.css
  25
  26   Test by browsing "http://<host>/cgi-bin/darcs.cgi/".
  27
  28 troubleshooting
  29
  30   if the configuration is incorrect error messages will be printed to
  31   the webserver's error log, for example "/var/log/apache/error.log".
  32
  33   you can also double check the configuration by running darcs.cgi
  34   from the command line and supplying a --check argument:
  35
  36      $ ./darcs.cgi --check
  37
  38 character encodings
  39
  40   if your repositories contain files with characters encoded in
  41   something other than ASCII or UTF-8, change the 'xml_encoding'
  42   setting in cgi.conf to the appropriate encoding.