commit abd2b7df772f351d0f8bf37712b9ddcf8e31a20f
parent 3bdf425bcfaaa1fb294c003975863b588bde9e54
Author: parazyd <parazyd@dyne.org>
Date: Tue, 18 Jul 2017 01:12:00 +0200
refresh documentation
Diffstat:
2 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -19,7 +19,8 @@ of the according `Release` files.
Dependencies
------------
-amprolla requires at least Python 3.4, and some external modules for it.
+amprolla requires Python 3, and some external modules for it. The lowest
+version it's been tested on was Python 3.4.
### Devuan/Debian
@@ -44,7 +45,7 @@ repositories we will merge afterwards. When this is done, you can run
sign the Release files needed. The first time this is done, it is
advisable to run the script found in `contrib/populate_aliases.sh` so
it can fill in the needed symlinks to the different suites. Make sure
-you set the correct path in the script.
+you set the correct paths and names in the script.
To perform incremental updates, run `orchestrate.sh` with a cron job
in your desired intervals. Edit the script to set the correct paths.
@@ -53,7 +54,6 @@ in your desired intervals. Edit the script to set the correct paths.
loop in order to be ran in tmux to catch unhandled exceptions and fix
the codebase.
-An `nginx` configuration for the amprolla server can be found in
-`contrib`.
+`nginx` and `lighttpd` configurations can be found in `contrib`.
More documentation should be found in the `doc` directory.
diff --git a/doc/setup.md b/doc/setup.md
@@ -110,6 +110,10 @@ and fill out the proper names needed. It will populate the merged
directory with symlinks to certain versions such as `1.0`, `stable`, or
`testing`.
+To merge Contents files, run `amprolla_merge_contents.py`. This module
+does not do incremental updates and should not be ran often due to its
+heavy IO/RAM requirements.
+
Incremental updates are performed through `amprolla_update.py`, however,
for more stable performance and uptime, the incremental updating is
being orchestrated by a shell script called `orchestrate.sh`. This shell
@@ -124,4 +128,5 @@ If you prefer, you can remove this loop and run the shell script through
a cron job based on your needs.
To actually serve the merged directory over HTTP, a basic nginx
-configuration is provided as `contrib/nginx.conf`.
+configuration is provided as `contrib/nginx.conf`, and a lighttpd conf
+is provided in `contrib/lighttpd.conf`.
