diff options
context:
space:
mode:
authorBryce Kwon <bryce@brycekwon.com>
committerBryce Kwon <bryce@brycekwon.com>
commit
parent
tree
download
Reorganize the tree into vendor/ and custom/
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt25
1 file changed, 6 insertions, 19 deletions
diff --git a/README.txt b/README.txt
index d385d31..b1ff14a 100644
--- a/README.txt
+++ b/README.txt
@@ -5,19 +5,6 @@ This is an attempt to create a fast web interface for the Git SCM, using a
built-in cache to decrease server I/O pressure.
-Repository layout
------------------
-
- source/ the C sources, the build fragment and the version script
- libraries/ the bundled Git tree, tracked as a submodule
- assets/ cgit.css, cgit.js and the images cgit serves
- extensions/ optional runtime filter scripts
- examples/ a commented cgitrc, git hooks and web server configs
- tools/ developer tooling (preview server and release build)
- tests/ the test suite
- build/ everything the build generates, and not tracked in git
-
-
Installation
------------
@@ -47,7 +34,7 @@ configure this location (and a few other things) by providing a `cgit.conf` file
(see the Makefile for details).
Lua is optional and only powers the lua: filter extensions (authentication,
-email and commit-message filters in extensions/). A plain build auto-detects a
+email and commit-message filters in custom/extensions/). A plain build auto-detects a
Lua through pkg-config, preferring LuaJIT, and falls back to a Lua-less binary
when none is found. Acceptable values are generally "luajit", "lua", "lua5.4",
"lua5.3", "lua5.2" and "lua5.1".
@@ -87,7 +74,7 @@ needed.
Filter extensions
-----------------
-The optional Lua filters in `extensions/` need extra Lua modules. Each script's
+The optional Lua filters in `custom/extensions/` need extra Lua modules. Each script's
header lists the exact install commands for its own dependencies.
* The auth filters (`auth-file.lua`, `auth-inline.lua`) need `luaossl` and
@@ -108,7 +95,7 @@ Web server configuration
------------------------
cgit is a CGI program. Complete, commented configurations for nginx, Apache and
-lighttpd live in `examples/servers/`, each explaining how that server routes
+lighttpd live in `custom/servers/`, each explaining how that server routes
requests to the binary and serves the static assets off disk.
@@ -118,7 +105,7 @@ Runtime configuration
The file `/etc/cgitrc` is read by cgit before handling a request. In addition to
runtime parameters, this file may also contain a list of repositories displayed
by cgit (see `cgitrc.5.txt` for further details). A fully commented starting
-point with every option at its default is in `examples/cgitrc`.
+point with every option at its default is in `custom/cgitrc`.
Securing an instance
@@ -131,11 +118,11 @@ documented in `cgitrc.5.txt`.
marker filename so only repositories that contain it are published.
* Gate the whole instance behind a login with `auth-filter`. Two example filters
- ship in `extensions/`, `auth-inline.lua` and `auth-file.lua`.
+ ship in `custom/extensions/`, `auth-inline.lua` and `auth-file.lua`.
* Terminate TLS at the web server in front of cgit.
-* The example configs in `examples/servers/` set a Content-Security-Policy and
+* The example configs in `custom/servers/` set a Content-Security-Policy and
related headers at the web server, where they also cover the static assets.
* `max-blob-size` bounds how much a single request reads into memory, and