aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorrexxnor <rexxnor+gnunet@brief.li>2019-01-20 15:03:24 +0100
committerrexxnor <rexxnor+gnunet@brief.li>2019-01-25 17:27:29 +0100
commitd91f5dcc352b6116e346c2a45edfd72ed4de3f9a (patch)
tree2dde9969f4ea3ef41e3055ce97ad8377791c802b /doc
parent2798cec3ad8c31397ccedef2dfca7f957efa0fa7 (diff)
downloadgnunet-d91f5dcc352b6116e346c2a45edfd72ed4de3f9a.tar.gz
gnunet-d91f5dcc352b6116e346c2a45edfd72ed4de3f9a.zip
fixed typos, improved ascension documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/handbook/chapters/developer.texi27
-rw-r--r--doc/handbook/chapters/installation.texi10
-rw-r--r--doc/handbook/chapters/user.texi8
3 files changed, 24 insertions, 21 deletions
diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi
index af3ac0197..1d3e1d3fb 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/handbook/chapters/developer.texi
@@ -8079,11 +8079,8 @@ This includes some of well known utilities, like "ping" and "nslookup".
8079 8079
8080@c %**end of header 8080@c %**end of header
8081 8081
8082This section will mainly comprise of the challenges and problems faced when 8082This section discusses the challenges and problems faced when writing the
8083writing the ascension tool. 8083ascension tool. It also takes a look at possible improvements in the future.
8084
8085When considering to migrate existing into GNS there are a few things to
8086consider.
8087 8084
8088@menu 8085@menu
8089* Conversions between DNS and GNS:: 8086* Conversions between DNS and GNS::
@@ -8095,19 +8092,16 @@ consider.
8095@subsubsection Conversions between DNS and GNS 8092@subsubsection Conversions between DNS and GNS
8096 8093
8097The differences between the two name systems lies in the details 8094The differences between the two name systems lies in the details
8098and is not visible from the start. For instance an SRV record is converted to a 8095and is not always transparent. For instance an SRV record is converted to a
8099gnunet only BOX record. 8096gnunet only BOX record.
8100 8097
8101This is done by building a BOX record from an existing SRV record: 8098This is done by converting to a BOX record from an existing SRV record:
8102 8099
8103@example 8100@example
8101# SRV
8104# _service._proto.name. TTL class SRV priority weight port target 8102# _service._proto.name. TTL class SRV priority weight port target
8105_sip._tcp.example.com. 14000 IN SRV 0 0 5060 www.example.com. 8103_sip._tcp.example.com. 14000 IN SRV 0 0 5060 www.example.com.
8106@end example 8104# BOX
8107
8108Which can be transformed to a GNS BOX record by converting it like this:
8109
8110@example
8111# TTL BOX flags port protocol recordtype priority weight port target 8105# TTL BOX flags port protocol recordtype priority weight port target
811214000 BOX n 5060 6 33 0 0 5060 www.example.com 810614000 BOX n 5060 6 33 0 0 5060 www.example.com
8113@end example 8107@end example
@@ -8137,7 +8131,7 @@ gnunet-namestore -z example.com -n mail -R 3600 MX n 10,mail
8137@end example 8131@end example
8138 8132
8139Finally, one of the biggest struggling points was the NS records that are found 8133Finally, one of the biggest struggling points was the NS records that are found
8140in top level domain zones. The inteded behaviour for those is to add GNS2DNS 8134in top level domain zones. The intended behaviour for those is to add GNS2DNS
8141records for the zone so that gnunet-gns can resolve the for those domain on it's 8135records for the zone so that gnunet-gns can resolve the for those domain on it's
8142own. Also a very important aspect of this is, that gnunet needs to be able to 8136own. Also a very important aspect of this is, that gnunet needs to be able to
8143resolve the nameservers from it's own database. This requires migration of the 8137resolve the nameservers from it's own database. This requires migration of the
@@ -8167,6 +8161,11 @@ resolvable even if they expired. However this would introduce the problem of how
8167to detect if a record has been removed from the zone and would require deletion 8161to detect if a record has been removed from the zone and would require deletion
8168of said record(s). 8162of said record(s).
8169 8163
8164Another problem that still persists is how to refresh records. Expired records
8165are still displayed when calling gnunet-namestore but do not resolve with
8166gnunet-gns. When doing incremental zone transfers this becomes especially
8167apparent.
8168
8170@node Performance 8169@node Performance
8171@subsubsection Performance 8170@subsubsection Performance
8172The performance when migrating a zone using the ascension tool is limited by a 8171The performance when migrating a zone using the ascension tool is limited by a
@@ -8178,7 +8177,7 @@ resource heavy and was optimized during development by adding the '-R'
8178at once using the CLI. 8177at once using the CLI.
8179 8178
8180The result of this was a much faster migration of TLD zones, as most records 8179The result of this was a much faster migration of TLD zones, as most records
8181with the same label have two nameservers. 8180with the same label have two name servers.
8182 8181
8183Another improvement that could be made is with the addition of multiple threads 8182Another improvement that could be made is with the addition of multiple threads
8184when opening the gnunet CLI tools. This could be implemented by simply creating 8183when opening the gnunet CLI tools. This could be implemented by simply creating
diff --git a/doc/handbook/chapters/installation.texi b/doc/handbook/chapters/installation.texi
index 9a64feef7..bdff20802 100644
--- a/doc/handbook/chapters/installation.texi
+++ b/doc/handbook/chapters/installation.texi
@@ -1698,7 +1698,11 @@ configured proxy) should give you a valid SSL certificate for
1698@subsubsection Migrating existing DNS zones into GNS 1698@subsubsection Migrating existing DNS zones into GNS
1699 1699
1700To migrate an existing zone into GNS use the ascension tool. 1700To migrate an existing zone into GNS use the ascension tool.
1701You can find the source code here: @code{} 1701
1702Ascension transfers entire zones into GNS by doing incremental zone transfers
1703and then adding the records to GNS.
1704
1705You can find the source code here: @code{https://gnunet.org/git/ascension.git/}
1702 1706
1703The software can be installed into a python virtual environment like this: 1707The software can be installed into a python virtual environment like this:
1704@example 1708@example
@@ -1712,7 +1716,9 @@ Or installed globally like this (not recommended):
1712$ sudo python3 setup.py install 1716$ sudo python3 setup.py install
1713@end example 1717@end example
1714 1718
1715The advantage of using a virtual environment is, that all the dependencies can be installed separately in different versions without touching your existing python installation and their dependencies. 1719The advantage of using a virtual environment is, that all the dependencies can
1720be installed separately in different versions without touching your existing
1721python installation and its dependencies.
1716 1722
1717Using the tool is discussed in the user section of the documentation. 1723Using the tool is discussed in the user section of the documentation.
1718 1724
diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi
index 76d39b50e..a659be9a3 100644
--- a/doc/handbook/chapters/user.texi
+++ b/doc/handbook/chapters/user.texi
@@ -1916,17 +1916,15 @@ Options:
1916 -v --version Show version. 1916 -v --version Show version.
1917@end example 1917@end example
1918 1918
1919To migrate the Syrian top level domain - one of the few top level domains that still support zone transfers - use the following command: 1919To migrate the Syrian top level domain - one of the few top level domains that still supports zone transfers - use the following command:
1920 1920
1921@example 1921@example
1922$ ascension sy. -ns ns1.tld.sy. 1922$ ascension sy. -ns ns1.tld.sy.
1923@end example 1923@end example
1924 1924
1925This will take a while but after it has finished executing the zone will have been migrated into GNS. 1925The program will continue to run as a daemon and update once the refresh time specified in the zones SOA record has elapsed.
1926 1926
1927The program will continue to run daemon and update once the refresh time specified in the zones SOA record has elapsed. 1927At this point you might want to write for example a systemd unit file to start and enable the service, so that your zone is migrated automatically.
1928
1929At this point it is trivial to write for example a systemd unit file and to enable the service, so that your zone is migrated periodically.
1930 1928
1931@node re@:claim Identity Provider 1929@node re@:claim Identity Provider
1932@section re@:claim Identity Provider 1930@section re@:claim Identity Provider