Browse Source

refresh documentation

parazyd 6 years ago
Signed by untrusted user: parazyd GPG Key ID: F0CB28FCF78637DE
  1. 8
  2. 7


@ -19,7 +19,8 @@ of the according `Release` files.
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/` 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 `` 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
`nginx` and `lighttpd` configurations can be found in `contrib`.
More documentation should be found in the `doc` directory.


@ -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
To merge Contents files, run ``. 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 ``, however,
for more stable performance and uptime, the incremental updating is
being orchestrated by a shell script called ``. 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`.