diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 33 |
1 files changed, 33 insertions, 0 deletions
@@ -51,6 +51,7 @@ Dependencies * libzip * libcrypto (OpenSSL) * libssl (OpenSSL) +* optional: Go compiler, to build cgitd * optional: luajit or lua, most reliably used when pkg-config is available Apache configuration @@ -67,6 +68,38 @@ like this: </Directory> +Running with cgitd +------------------- + +The cmd/cgitd provides a quick alternatives to setup and run cgit +without installing another second application (usually a web server with +their own configuration). + +To build and run cgitd you needs the Go compiler. + +Cgitd needs five environment variables, two are requireds, and three are +optionals. +Required variables are, + +- CGITD_CGIT_BIN: path to cgit.cgi +- CGITD_CGIT_STATIC_DIR: path to directory that contains cgit.css and + cgit.js + +The three optional variables are, + +- CGITD_LISTEN: address and port to serve HTTP connections, default to + "127.0.0.1:19418". +- CGITD_REPO_PREFIXES: comma separated prefix that used in repo.url. +- CGITD_STATIC_DIR: path to directory that contains favicon and logo. + If set, the content of this directory will be served under "/static/" + path, so make sure to add that prefix to favicon= and logo= in cgitrc. +- CGIT_CONFIG: path to cgitrc + +Once sets, you can build and run cgitd using the following commands, + + $ go build ./cmd/cgitd + $ ./cgitd + Runtime configuration --------------------- |