diff --git a/README.md b/README.md new file mode 100644 index 0000000..1788592 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# PDA-New + +A from-the-ground-up rewrite and reimplementation of PowerDNS-Admin + +Like its predecessor, it will communicate with PDNS via the latter's web API, and add user access control and a proper web frontend. + +## Requirements +A system capable of running python. + +## Building + +Use python to create a virtual environment, then activate it: +``` +python3 -m venv .venv +source .venv/bin/activate +``` + +Use pip to install the required modules: +``` +pip3 install --upgrade pip +pip3 install -f src/requirements.txt +``` + +## Installation + +Run it manually via: +``` +python3 src/manage.py test +``` + +For production environments, gunicorn or a similar UWSGI implementation, preferably using a webserver as a proxy is recommended. +