ascension

Migrate DNS zones to the GNU Name System
Log | Files | Refs | README | LICENSE

README (2089B)


      1 # Ascension
      2 
      3 Tool to easily migrate existing DNS Zones into the GNU Name System using
      4 incremental zone transfers (AXFR/IXFR).
      5 
      6 ## How to install
      7 To install the ascension simply execute one of the following commands in the
      8 freshly cloned directory:
      9 
     10 ```bash
     11 # System wide installation
     12 sudo python3 setup.py install
     13 
     14 # Local installation through virtualenv
     15 python3 -m venv .venv
     16 source .venv/bin/activate
     17 pip install .
     18 ```
     19 
     20 ## How to install (Developer)
     21 A developer installation is very handy when you are making changes to the source
     22 code as this way you don't need to re-run the installation procedure every time
     23 you make a change.
     24 
     25 ```bash
     26 # installation through virtualenv
     27 python3 -m venv .venv
     28 source .venv/bin/activate
     29 pip install -e .
     30 ```
     31 
     32 ## How to use
     33 If you have installed it, simply execute ascension with one of several options.
     34 You can also just run the file ascension.py itself directly.
     35 
     36 Taken from the docstring of the ascension.py file:
     37 ```
     38 usage: ascension [-h] [-n NAMESERVER] [-P PORT] [-k KEYFILE] [-l LOGLEVEL] [-t TTL] [-s] [-p] [-g] [-V] domain
     39 
     40 Easy tool to migrate DNS zones into GNS
     41 
     42 positional arguments:
     43   domain                Domain to be migrated into GNS
     44 
     45 options:
     46   -h, --help            show this help message and exit
     47   -n NAMESERVER, --nameserver NAMESERVER
     48                         Nameserver to use for migrating
     49   -P PORT, --port PORT  Port to use for zone transfer with nameserver
     50   -k KEYFILE, --keyfile KEYFILE
     51                         Keyfile to use for DNS TSIG
     52   -l LOGLEVEL, --loglevel LOGLEVEL
     53                         Loglevel to use, 10 Debug, 20 Info, 30 Warning, 40 Error, 50 Critical
     54   -t TTL, --ttl TTL     Sets the minimum ttl of records added to GNS
     55   -s, --standalone      Run ascension once and not as daemon
     56   -p, --public          Push records to the public DHT
     57   -g, --dryrun          Tests if zone is transferrable without changing anything
     58   -V, --version         show program's version number and exit
     59 ```
     60 
     61 Example use:
     62 ```
     63 # Transfers the nu TLD from zonedata.iis.se with loglevel debug
     64 ascension nu -n zonedata.iis.se. -l10
     65 ```