README

   1 Ocsigen server
   2
   3 ------------------------------------------------------------------
   4
   5 Requirements:
   6 =============
   7
   8 Compilers:
   9
  10  * ocaml and camlp4  (need version >= 3.12)
  11  * a C compiler      (tested with gcc-4.4.5)
  12
  13 Libraries:
  14
  15  * findlib
  16  * react             (tested with 0.9.2)
  17  * ocamlssl          (tested with 0.4.4)
  18  * lwt               (need version >= 2.3.0, with react and ssl support)
  19  * ocamlnet          (tested with 2.2.9 and 3.2, with netstring and netsys)
  20  * pcre-ocaml        (tested with 6.0.1)
  21  * cryptokit         (tested with 1.3)
  22  * ocaml-text        (tested with 0.3)
  23  * tyxml             (need version 2.0)
  24
  25 Optional libraries:
  26
  27  * ocamlsqlite3      (tested with 1.5.6)
  28  * camlzip           (tested with 1.0.4)
  29
  30 You may also use the dbm database (for example gdbm) instead of
  31 sqlite.  In that case, you need dbm with headers (libgdbm-dev package
  32 for ex.)
  33
  34 If OCaml 3.12 and the needed libraries (findlib/react/lwt...) are not
  35 installed on your computer and not available on your favorite linux
  36 distribution, you may use the Ocsigen bunble GODI to install them
  37 automatically, see:
  38
  39   http://ocsigen.org/install#bundle
  40   http://godi.camlcity.org/godi/index.html
  41
  42 To run the native code version of ocsigen server, you may need to
  43 generate cmxs files for the libraries you need, if they are not
  44 included in your distribution, see:
  45
  46   http://ocsigen.org/ocsigenserver/manual/misc
  47
  48
  49 ------------------------------------------------------------------
  50
  51 Build instructions:
  52 ===================
  53
  54  * run "sh configure [options]" to generate 'Makefile.config'
  55  - For the full list of options, run "sh configure --help".
  56
  57  * verify that 'Makefile.config' suits to your needs.
  58
  59  * run "make" to compile
  60  * run "make install" as root to install
  61
  62  * [optional] run "make logrotate" as root to install logrotate
  63               configuration files in /etc/logrotate.d
  64
  65  * [optional] run "make doc" to build the ocamldoc
  66  * [optional] run "make install.doc" as root to install the ocamldoc
  67
  68  * run "make uninstall" to uninstall (almost) everything
  69
  70 ------------------------------------------------------------------
  71
  72 Local testings:
  73 ===============
  74
  75  * run "make run.local" of "make run.opt.local"
  76    in the ocsigen source directory.
  77
  78  * open http://localhost:8080/index.html in your browser
  79
  80  * if it does not work, look at the logs (see 'local/var/log/' in the
  81    ocsgigen source directory) or run ocsigen with options -v or -V
  82    (verbose and debug mode).
  83
  84 ------------------------------------------------------------------
  85
  86 Authors:
  87 ========
  88
  89 Vincent Balat
  90  (project leader, Web server, Ocsigenmod, Eliom, Eliom client, Staticmod, XHTML syntax extension, documentation, Ocsimore, extension mechanism, Ocsidbm, Ocsipersist with DBM, ...)
  91 Jérôme Vouillon
  92 (Lwt, Web server, js_of_ocaml, O'Closure, ...)
  93 Boris Yakobowski
  94 (Ocsimore, module Extendconfiguration, Ocsigen server...)
  95 Benjamin Canou
  96 (O'Browser)
  97 Jérémie Dimino
  98 (Lwt)
  99 Raphaël Proust
 100 (Ocsforge, Eliom client, Comet)
 101 Stéphane Glondu
 102 (Configuration file, Findlib integration, access control, HTTP authentication, Debian package, ...)
 103 Gabriel Kerneis
 104 (XHTML syntax extension for OCaml 3.10, Ocsipersist with SQLite, CGI module, forms in Eliom, deflatemod, ...)
 105 Denis Berthod
 106 (HTTP protocol, Web server)
 107 Grégoire Henry
 108 (safe unmarshalling of client data)
 109 Pierre Chambart
 110 (Comet)
 111 Jaap Boender
 112 (Ocsimore, NetBSD and Godi packages)
 113 Gabriel Scherer
 114 (Macaque)
 115 Gabriel Cardoso
 116 (O'Closure)
 117 Jean-Henri Granarolo
 118 (Ocsforge)
 119 Simon Castellan
 120 (HTML5, OpenID, SVG)
 121 Piero Furiesi
 122 (Ocsimore)
 123 Thorsten Ohl
 124 (most of the functions generating XHTML (xML and xHTML modules))
 125 Mauricio Fernandez
 126 (Xhtmlcompact, static linking of extensions and Eliom modules)
 127 Nataliya Guts
 128 (Web server, HTTPS)
 129 Archibald Pontier
 130 (Atom, Pubsubhubbub)
 131 Jérôme Velleine
 132 (CGI module)
 133 Charles Oran
 134 (O'Closure)
 135 Pierre Clairambault
 136 (Lwt_lib, Gentoo package, configure script, ...)
 137 Cécile Herbelin
 138  (HTML5, Benchmarks)