README.md 2.21 KB
Newer Older
Mattias Päivärinta's avatar
Mattias Päivärinta committed
1
# Zonemaster Backend
2
[![Build Status](https://travis-ci.org/zonemaster/zonemaster-backend.svg?branch=master)](https://travis-ci.org/zonemaster/zonemaster-backend)
Patrik Wallström's avatar
Patrik Wallström committed
3

Mattias Päivärinta's avatar
Mattias Päivärinta committed
4

5
6
7
### Purpose
This repository is one of the components of the Zonemaster software. For an
overview of the Zonemaster software, please see the
8
[Zonemaster repository](https://github.com/zonemaster/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
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
Mattias Päivärinta's avatar
Mattias Päivärinta committed
17
analysing.
18
19


20
### Prerequisites
21

22
23
Before you install the Zonemaster Backend, you need the
Zonemaster Engine installed. Please see the
24
[Zonemaster Engine installation
25
instructions](https://github.com/zonemaster/zonemaster-engine/blob/master/docs/Installation.md).
26

Mattias Päivärinta's avatar
Mattias Päivärinta committed
27

28
### Upgrade
29

30
See the [upgrade document].
31

Mattias Päivärinta's avatar
Mattias Päivärinta committed
32

33
### Installation
Patrik Wallström's avatar
Patrik Wallström committed
34

35
Follow the detailed [installation instructions].
Patrik Wallström's avatar
Patrik Wallström committed
36
37


Mattias Päivärinta's avatar
Mattias Päivärinta committed
38
### Configuration
39

Mattias Päivärinta's avatar
Mattias Päivärinta committed
40
See the [configuration documentation].
41

Patrik Wallström's avatar
Patrik Wallström committed
42

43
### Documentation
Patrik Wallström's avatar
Patrik Wallström committed
44

45
46
47
48
49
50
51
52
53
54
The Zonemaster Backend documentation is split up into several documents:

* A number of [Typographic Conventions](docs/TypographicConventions.md) are used
  throughout this documentation.
* The [Architecture](docs/Architecture.md) document describes each of the
  Zonemaster Backend components and how they operate. It also discusses all
  central concepts needed to understand the Zonemaster backend, and contains a
  glossary over domain specific technical terms.
* The [Getting Started](docs/GettingStarted.md) guide walks you through creating
  a *test* and following it through its life cycle, all using JSON-RPC calls to
Michal TOMA's avatar
Michal TOMA committed
55
56
  the *RPC API daemon*.
* The [API](docs/API.md) documentation describes the *RPC API daemon* inteface in
57
58
  detail.

Patrik Wallström's avatar
Patrik Wallström committed
59

Mattias Päivärinta's avatar
Mattias Päivärinta committed
60
## License
Patrik Wallström's avatar
Patrik Wallström committed
61

Patrik Wallström's avatar
Patrik Wallström committed
62
63
The software is released under the 2-clause BSD license. See separate
[LICENSE](LICENSE) file.
Mattias Päivärinta's avatar
Mattias Päivärinta committed
64
65
66


[Configuration documentation]: docs/Configuration.md
mats Dufberg's avatar
mats Dufberg committed
67
[Installation instructions]:   docs/Installation.md
68
[Upgrade document]:            docs/Upgrade.md