README.md 1.56 KB
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
7
8
### Purpose
This repository is one of the components of the Zonemaster software. For an
overview of the Zonemaster software, please see the
[Zonemaster repository](https://github.com/dotse/zonemaster).
Patrik Wallström's avatar
Patrik Wallström committed
9
10
11
12
13
14

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)

15
16
17
18
19
20
21
22
23
24
25
26
27
A Zonemaster user needs to install the backend only in the case where there is a
need of logging the Zonemaster test runs in one's own respective database for
analysing.  


### Prerequisites

Before you install the Zonemaster CLI utility, you need the
Zonemaster Engine test framework installed. Please see the
[Zonemaster Engine installation
instructions](https://github.com/dotse/zonemaster-engine/blob/master/docs/installation.md)

### Installation
Patrik Wallström's avatar
Patrik Wallström committed
28

Patrik Wallström's avatar
Patrik Wallström committed
29
Follow the detailed [installation instructions](docs/installation.md).
Patrik Wallström's avatar
Patrik Wallström committed
30

31
### Configuration 
Patrik Wallström's avatar
Patrik Wallström committed
32

33
34
Text for configuring the backend are found in the [installation
instructions](docs/installation.md).
Patrik Wallström's avatar
Patrik Wallström committed
35

36
### Documentation
Patrik Wallström's avatar
Patrik Wallström committed
37

38
There is a fully documented [API](docs/API.md), which is the primay way
39
40
to use the backend. The [docs](docs/) directory also contains the SQL commands
for manipulating the database. 
Patrik Wallström's avatar
Patrik Wallström committed
41
42
43
44

License
=======

Patrik Wallström's avatar
Patrik Wallström committed
45
46
The software is released under the 2-clause BSD license. See separate
[LICENSE](LICENSE) file.
Patrik Wallström's avatar
Patrik Wallström committed
47
48