Commit 7bd9475a authored by Sandoche Balakrichenan's avatar Sandoche Balakrichenan
Browse files

updated the docs in the backend

parent bccf35ca
......@@ -2,30 +2,42 @@ Zonemaster
==========
[![Build Status](https://travis-ci.org/dotse/zonemaster-backend.svg?branch=master)](https://travis-ci.org/dotse/zonemaster-backend)
Zonemaster is a cooperative project between IIS and AFNIC. It is a successor
to both IIS's DNSCheck and AFNIC's Zonecheck.
### 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).
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
============
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
Follow the detailed [installation instructions](docs/installation.md).
Prerequisites
=============
### Configuration
The other perl modules required to run the Zonemaster Backend module are
listed in Makefile.PL as usual.
Text for configuring the backend are found in the [installation
instructions](docs/installation.md).
Documentation
=============
### Documentation
There is a fully documented [API](docs/API.md), which is the primay way
to use the backend.
to use the backend. The [docs](docs/) directory also contains the SQL commands
for manipulating the database.
License
=======
......
......@@ -2,16 +2,16 @@
The documentation covers the following operating systems:
* Ubuntu 14.04 (LTS)
* Debian Wheezy (version 7)
* FreeBSD 10
* [1] <a href="#Debian">Ubuntu 14.04 (LTS)</a>
* [2] <a href="#Debian">Debian Wheezy (version 7)</a>
* [3] <a href="#FreeBSD">FreeBSD 10</a>
## Pre-Requisites
Zonemaster-engine should be installed before. Follow the instructions
[here](https://github.com/dotse/zonemaster/blob/master/docs/documentation/installation.md)
## Instructions for installing in Ubuntu 14.04 and Debian wheezy (version 7)
## <a name="Debian"></a> Instructions for installing in Ubuntu 14.04 and Debian wheezy (version 7)
1) Install package dependencies
......@@ -251,7 +251,7 @@ Next step is to install the [Web UI](https://github.com/dotse/zonemaster-gui/blo
## FreeBSD 10.0 & 10.1 Instructions
## <a name="FreeBSD"></a> FreeBSD 10.0 & 10.1 Instructions
First, make sure your operating system and package database is up to date.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment