commit 81683c98e459b37667fb94231ff8daa250047530 parent 47afd11be26d8b939bd37327e8230e9bb8a4481a Author: rexxnor <rexxnor+gnunet@brief.li> Date: Wed, 26 Sep 2018 21:47:52 +0200 updated README Diffstat:
| M | README.md | | | 47 | +++++++++++++++++++++++++++++++++++++++-------- |
1 file changed, 39 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md @@ -1,27 +1,58 @@ # GNS Migrator The main goal is to develop a tool to easily migrate existing DNS Zones to the -GNU Name System +GNU Name System using incremental Zone Transfers. (IXFR) -## How to use +## How to install +To install the gnsmigrator 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 +``` -To use the program simply execute python3 on the gnsmigrator.py file. -At a later stage this will be possible to do by installing the program and after execute it directly using "gnsmigrator" +## 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 gnsmigrator with one of several options.. +You can also just run the file gnsmigrator.py itself directly. Taken from the dosctring of the gnsmigrator.py file: ``` GNS Migrator Usage: - gnsmigrator.py <file> + gnsmigrator.py (-c <csv> | -f <txtfile>) + gnsmigrator.py (-c <csv> | -f <txtfile>) -r <resolver> gnsmigrator.py -h | --help - gnsmigrator.py --version + gnsmigrator.py -v | --version Options: - <file> CSV File containing domains to transfer + <csv> CSV File containing domains to transfer + <txtfile> Text File containing domains to transfer + <resolver> DNS Server that resolves missing domains -h --help Show this screen. - --version Show version. + -v --version Show version. ``` +Example use: +``` +# Reads domains from CSV, setup GNS Zones and adds records from zone transfer +gnsmigrator -c domainlist.csv +# Reads domains from Textfile, setup GNS Zones and adds records from zone transfer +gnsmigrator -f domainlist.txt +# Does the above and adds GNS2DNS records for every non-zone local NS record using provided resolver +gnsmigrator -f domainlist.txt -r 1.1.1.1 +```