aboutsummaryrefslogtreecommitdiff
path: root/docs/central/Configuration.md
blob: 05cf3bbdda61b714f02cbe2c836daa21e0e31378 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Configuration references

The configuration format of central is JSON.

## Reference

```json
{
  "database": {
    "port": 3306,
    "host": "host.name.or.ip.for.MySQL.database",
    "database": "mysql database",
    "user": "test",
    "password": "123456"
  },
  "http": {
    "name": "<Site name> It will appear like <name> dn42 peering."
  },
  "mail": {
    "hostname": "SMTP hostname",
    "port": 587,
    "starttls": "DISABLED / OPTIONAL / REQUIRED",
    "username": "SMTP username",
    "password": "SMTP password",
    "from": "Postmaster <postmaster@example.tld>"
  },
  "whois": "localhost (Whois hostname. See below # Whois)"
}
```

## Database

A MySQL database with predefined schema is required for central to operate. See [Database](Database.md) section for more details.

## SMTP

A smtp server is required for email verification. A recommendation is mail services like MailGun.

## Whois

A whois server that is capable of looking up dn42 ASN's and routes is required for ASN and IP verification.

An example is [whois42d](https://github.com/Mic92/whois42d), but make sure you delete all contents under `data/inetnum` and `data/inet6num` or whois42d will not lookup routes.

## Configuration Location and Reloading