aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6ac54afb8e6c849d446df4faa0b2d9e04c85e0b3 (plain) (blame)
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
47
48
49
50
51
52
53
54
55
56
57
58
# Ascension

The main goal is to develop a tool to easily migrate existing DNS Zones to the
GNU Name System using (incremental) Zone Transfers. (AXFR/IXFR)

## How to install
To install the ascension simply execute one of the following commands:

```bash
# System wide installation
sudo python3 setup.py install

# Local installation through virtualenv
python3 -m venv .venv
source .venv/bin/activate
python3 setup.py install
```

## How to install (Developer)
```bash
# installation through virtualenv
python3 -m venv .venv
source .venv/bin/activate
python3 setup.py develop
```

## How to use
If you have installed it, simply execute ascension with one of several options.
You can also just run the file ascension.py itself directly.

Taken from the dosctring of the ascension.py file:
```
Ascension

Usage:
    ascension.py <domain> [-d]
    ascension.py <domain> -p <port> [-d]
    ascension.py <domain> -ns <transferns> [-d]
    ascension.py <domain> -ns <transferns> -p <port> [-d]
    ascension.py -h | --help
    ascension.py -v | --version

Options:
    <port>          Port for zone transfer
    <domain>        Domain to migrate
    <transferns>    DNS Server that does the zone transfer
    -d --debug      Enable debugging
    -h --help       Show this screen.
    -v --version    Show version.
```

Example use:
```
# Transfers the sy TLD from ns1.tld.sy.
ascension sy -ns ns1.tld.sy.
# Transfers the nu TLD from zonedata.iis.se with debug options enabled
ascension nu -ns zonedata.iis.se. -d
```