Updated readme for dev branch
This commit is contained in:
parent
fae6ac469b
commit
800a832975
42
README.md
42
README.md
|
@ -1,22 +1,34 @@
|
|||
# PDNS Manager
|
||||
|
||||
[PDNS Manager](https://pdnsmanager.lmitsystems.de) is a simple yet powerful free administration tool for the
|
||||
Powerdns authoritative nameserver. It supports master and native zones.
|
||||
## Caution
|
||||
This is the development branch for pdnsmanager it should become the 2.0 version if it is ready. If you want to use the software download a stable release from https://pdnsmanager.lmitsystems.de.
|
||||
|
||||
PNDS Manager was developed from scratch to achieve a user-friendly
|
||||
and pretty looking interface.
|
||||
This development version contains known bugs and security vulnerabilities. Do not use it!
|
||||
|
||||
PDNS Manager also features a powerful API to set records programatically.
|
||||
This can be used e.g. for a dynamic DNS service, but also to obtain certificates
|
||||
from [Let's Encrypt](https://letsencrypt.org/) via the dns-01 challenge.
|
||||
## Development Commands
|
||||
Before you can start you have to configure the backend manually with a valid config-user.php
|
||||
|
||||
PDNS Manager is written in PHP using [Bootstrap](http://getbootstrap.com/)
|
||||
and [jQuery](http://jquery.com/). The backend uses a MySQL/Maria DB or Postgres
|
||||
database. The database is also used by Powerdns using the pdns-backend-mysql or
|
||||
pdns-backend-pgsql backend.
|
||||
Also you have to install Angular CLI globally using
|
||||
```bash
|
||||
npm install -g @angular/cli
|
||||
```
|
||||
|
||||
## More information
|
||||
You can find more information and documentation as well as contact information on [pdnsmanager.lmitsystems.de](https://pdnsmanager.lmitsystems.de). There are also some tutorials to get you quickly up and running.
|
||||
Then change in the backend-legacy folder and start the backend in one terminal.
|
||||
```bash
|
||||
cd backend-legacy
|
||||
php -S localhost:8000
|
||||
```
|
||||
|
||||
Afterwords you can run the development-server in another terminal using
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
Then you now go to a browser and open http://localhost:4200
|
||||
|
||||
If you want to lint the project run
|
||||
```bash
|
||||
npm run lint
|
||||
```
|
||||
this command will be in a commit hook so that it is impossible to commit code which does not pass the linter.
|
||||
|
||||
## Contribute
|
||||
If you are looking for a new feature or you found a bug, feel free to create a pull request or open a issue.
|
||||
|
|
Loading…
Reference in a new issue