summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 1 insertions, 22 deletions
diff --git a/README b/README
index 09b1bbf..da3b255 100644
--- a/README
+++ b/README
@@ -8,26 +8,5 @@ Usage:
1. Run `make install`.
2. Configure your system to run /usr/lib/cgit/syntax-highlighting-server.py at
boot. This can be done by `systemctl enable syntax-highlighting` on systemd
- machines. Note that syntax-highlighting-server is very insecure. Therefore,
- do not configure it to listen on a public network.
+ machines.
3. Set your cgit source filter to syntax-highlighting-client.sh.
-
-Tuning:
-
-By default, syntax-highlighting-server does all work in a single thread. If you
-have a high query load and multiple CPUs, consider setting --listen-mode to
-forking or reuseport.
-
-reuseport mode uses one worker per CPU and is the highest performance mode, but
-requires Linux and additional idle memory (roughly 1-3 MB per worker).
-
-forking mode uses less idle memory and is compatible with non-Linux systems,
-but is significantly less efficient, since it forks for every request.
-
-Security:
-
-syntax-highlighting-server is not hardened against malicious clients which send
-malformed data or are simply excessively slow. Once again, do not configure
-syntax-highlighting-server to listen on a public network. It is also
-recommended to set max-blob-size in cgitrc, as the entire file must be buffered
-in memory during syntax highlighting.