README.md 2.66 KB
Newer Older
1
2
Zonemaster Backend
==================
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
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.  


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/dotse/zonemaster-engine/blob/master/docs/Installation.md).
26
27
28
29
30
31
32
33
34

### Upgrade 

If you are upgrading Zonemaster Backend from 1.0.X to 1.1.X please follow the
[upgrade instructions from 1.0.X to 1.1.X](docs/upgrade-from-1.0.x-to-1.1.x.md) and then follow the
relevant parts of the installation instructions below.

For all other upgrades follow the relevant parts of the installation
instructions below.
35
36

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

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

40
### Configuration 
Patrik Wallström's avatar
Patrik Wallström committed
41

mats Dufberg's avatar
mats Dufberg committed
42
43
44
Zonemaster *Backend* is configured as a whole from `/etc/zonemaster/backend_config.ini`
(CentOS, Debian and Ubuntu) or `/usr/local/etc/zonemaster/backend_config.ini`
(FreeBSD).
45
46
47
48
49

>
> At this time there is no documentation for `backend_config.ini`.
>

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

51
### Documentation
Patrik Wallström's avatar
Patrik Wallström committed
52

53
54
55
56
57
58
59
60
61
62
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
63
64
  the *RPC API daemon*.
* The [API](docs/API.md) documentation describes the *RPC API daemon* inteface in
65
66
67
68
69
  detail.

The [docs](docs/) directory also contains the SQL commands for manipulating the
database. 

Patrik Wallström's avatar
Patrik Wallström committed
70
71
72
73

License
=======

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