Added a basic README.md
All checks were successful
pda-new unit tests / Run-unit-tests (push) Successful in 21s
All checks were successful
pda-new unit tests / Run-unit-tests (push) Successful in 21s
This commit is contained in:
32
README.md
Normal file
32
README.md
Normal file
@@ -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.
|
||||||
|
|
||||||
Reference in New Issue
Block a user