diff --git a/README.md b/README.md new file mode 100644 index 0000000..87f2d7d --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# mod_webgate +mod_webgate is a basic request verification challenge intended to minimalize traffic created by various bots. +It is implemented as [Apache httpd](https://httpd.apache.org) module. + +## Installation +The intended way of installing this module is via the `apxs` utility. It can automatically build shared object with module by +passing appropriate flags to the C compiler and linker, install built module and activate it. + +The following command should be used to build, install and activate the module: +```console +apxs -c -i -a mod_webgate.c +``` +Depending on your system configuration it may be neccessary to run `apxs` as privileged user. \ No newline at end of file