ascension

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

README (2189B)

      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 python3 setup.py 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 python3 setup.py develop
     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 Ascension
     39 
     40 Usage:
     41     ascension <domain> [-d] [-p] [-s] [--minimum-ttl=<ttl>] [--dry-run]
     42     ascension <domain> <port> [-d] [-p] [-s] [--minimum-ttl=<ttl>]
     43     ascension <domain> -n <transferns> [-d] [-p] [-s] [--minimum-ttl=<ttl>] [--dry-run]
     44     ascension <domain> -n <transferns> <port> [-d] [-p] [-s] [--minimum-ttl=<ttl>] [--dry-run]
     45     ascension -p | --public
     46     ascension -s | --debug
     47     ascension -s | --standalone
     48     ascension -h | --help
     49     ascension -v | --version
     50 
     51 Options:
     52     <domain>              Domain to migrate
     53     <port>                Port for zone transfer
     54     <transferns>          DNS Server that does the zone transfer
     55     --minimum-ttl=<ttl>   Minimum TTL for records to migrate [default: 3600]
     56     --dry-run             Only try if a zone transfer is allowed
     57     -p --public           Make records public on the DHT
     58     -s --standalone       Run ascension once
     59     -d --debug            Enable debugging
     60     -h --help         Show this screen.
     61     -v --version      Show version.
     62 ```
     63 
     64 Example use:
     65 ```
     66 # Transfers the sy TLD from ns1.tld.sy.
     67 ascension sy -n ns1.tld.sy.
     68 # Transfers the nu TLD from zonedata.iis.se with debug options enabled
     69 ascension nu -n zonedata.iis.se. -d
     70 ```