From 482577fd53b42db8213406501e98bebfc0edae9c Mon Sep 17 00:00:00 2001 From: Julian Harty Date: Thu, 6 Apr 2017 00:02:27 +0100 Subject: [PATCH] You're welcome... and here's the starting point to encourage you to get involved. --- src/server/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 src/server/README.md diff --git a/src/server/README.md b/src/server/README.md new file mode 100644 index 0000000..f9e558f --- /dev/null +++ b/src/server/README.md @@ -0,0 +1,17 @@ +This is the home of what's currently a proof-of-concept (p-o-c) experiment to create a module for Apache 2 Web Servers that serves content from ZIM files. + +== Prerequisites == + +== Building the code == +The build is currently performed by a crude, limited bash script `build.sh` + +== Loading the new module == +Run `sudo service apache restart` + +== Known limitations == +Here are our known limitations, some will be removed or addressed as we enhance the code. + +- Hardcoded behaviour and ZIM file +- Not designed for multi-use or repeated-use +- No logging and no integration with Apache logging or error reporting +- No way to test the functionality except interactively and manually