README.md 1019 Bytes
Newer Older
Patrik Wallström's avatar
Patrik Wallström committed
1
2
Zonemaster
==========
Patrik Wallström's avatar
Patrik Wallström committed
3
[![Build Status](https://travis-ci.org/dotse/zonemaster-backend.svg?branch=master)](https://travis-ci.org/dotse/zonemaster-backend)
Patrik Wallström's avatar
Patrik Wallström committed
4

5
6
Zonemaster is a cooperative project between IIS and AFNIC. It is a successor
to both IIS's DNSCheck and AFNIC's Zonecheck.
Patrik Wallström's avatar
Patrik Wallström committed
7
8
9
10
11
12
13
14
15

This module is the Backend JSON/RPC weservice for the Web Interface part of
the Zonemaster project. It offers a JSON/RPC api to run tests one by one
(as the zonemaster-gui web frontend module does, or by using a batch API to
run the Zonemaster engine on many domains)

Installation
============

Patrik Wallström's avatar
Patrik Wallström committed
16
Follow the detailed [installation instructions](docs/installation.md).
Patrik Wallström's avatar
Patrik Wallström committed
17
18
19
20
21
22
23
24
25
26

Prerequisites
=============

The other perl modules required to run the Zonemaster Backend module are
listed in Makefile.PL as usual. 

Documentation
=============

27
28
There is a fully documented [API](docs/API.md), which is the primay way
to use the backend.
Patrik Wallström's avatar
Patrik Wallström committed
29
30
31
32

License
=======

Patrik Wallström's avatar
Patrik Wallström committed
33
34
The software is released under the 2-clause BSD license. See separate
[LICENSE](LICENSE) file.
Patrik Wallström's avatar
Patrik Wallström committed
35
36