diff options
author | rexxnor <rexxnor+gnunet@brief.li> | 2019-01-20 15:03:24 +0100 |
---|---|---|
committer | rexxnor <rexxnor+gnunet@brief.li> | 2019-01-25 17:27:29 +0100 |
commit | d91f5dcc352b6116e346c2a45edfd72ed4de3f9a (patch) | |
tree | 2dde9969f4ea3ef41e3055ce97ad8377791c802b /doc/handbook | |
parent | 2798cec3ad8c31397ccedef2dfca7f957efa0fa7 (diff) | |
download | gnunet-d91f5dcc352b6116e346c2a45edfd72ed4de3f9a.tar.gz gnunet-d91f5dcc352b6116e346c2a45edfd72ed4de3f9a.zip |
fixed typos, improved ascension documentation
Diffstat (limited to 'doc/handbook')
-rw-r--r-- | doc/handbook/chapters/developer.texi | 27 | ||||
-rw-r--r-- | doc/handbook/chapters/installation.texi | 10 | ||||
-rw-r--r-- | doc/handbook/chapters/user.texi | 8 |
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 | ||
8082 | This section will mainly comprise of the challenges and problems faced when | 8082 | This section discusses the challenges and problems faced when writing the |
8083 | writing the ascension tool. | 8083 | ascension tool. It also takes a look at possible improvements in the future. |
8084 | |||
8085 | When considering to migrate existing into GNS there are a few things to | ||
8086 | consider. | ||
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 | ||
8097 | The differences between the two name systems lies in the details | 8094 | The differences between the two name systems lies in the details |
8098 | and is not visible from the start. For instance an SRV record is converted to a | 8095 | and is not always transparent. For instance an SRV record is converted to a |
8099 | gnunet only BOX record. | 8096 | gnunet only BOX record. |
8100 | 8097 | ||
8101 | This is done by building a BOX record from an existing SRV record: | 8098 | This 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 | |||
8108 | Which 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 |
8112 | 14000 BOX n 5060 6 33 0 0 5060 www.example.com | 8106 | 14000 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 | ||
8139 | Finally, one of the biggest struggling points was the NS records that are found | 8133 | Finally, one of the biggest struggling points was the NS records that are found |
8140 | in top level domain zones. The inteded behaviour for those is to add GNS2DNS | 8134 | in top level domain zones. The intended behaviour for those is to add GNS2DNS |
8141 | records for the zone so that gnunet-gns can resolve the for those domain on it's | 8135 | records for the zone so that gnunet-gns can resolve the for those domain on it's |
8142 | own. Also a very important aspect of this is, that gnunet needs to be able to | 8136 | own. Also a very important aspect of this is, that gnunet needs to be able to |
8143 | resolve the nameservers from it's own database. This requires migration of the | 8137 | resolve 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 | |||
8167 | to detect if a record has been removed from the zone and would require deletion | 8161 | to detect if a record has been removed from the zone and would require deletion |
8168 | of said record(s). | 8162 | of said record(s). |
8169 | 8163 | ||
8164 | Another problem that still persists is how to refresh records. Expired records | ||
8165 | are still displayed when calling gnunet-namestore but do not resolve with | ||
8166 | gnunet-gns. When doing incremental zone transfers this becomes especially | ||
8167 | apparent. | ||
8168 | |||
8170 | @node Performance | 8169 | @node Performance |
8171 | @subsubsection Performance | 8170 | @subsubsection Performance |
8172 | The performance when migrating a zone using the ascension tool is limited by a | 8171 | The 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' | |||
8178 | at once using the CLI. | 8177 | at once using the CLI. |
8179 | 8178 | ||
8180 | The result of this was a much faster migration of TLD zones, as most records | 8179 | The result of this was a much faster migration of TLD zones, as most records |
8181 | with the same label have two nameservers. | 8180 | with the same label have two name servers. |
8182 | 8181 | ||
8183 | Another improvement that could be made is with the addition of multiple threads | 8182 | Another improvement that could be made is with the addition of multiple threads |
8184 | when opening the gnunet CLI tools. This could be implemented by simply creating | 8183 | when 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 | ||
1700 | To migrate an existing zone into GNS use the ascension tool. | 1700 | To migrate an existing zone into GNS use the ascension tool. |
1701 | You can find the source code here: @code{} | 1701 | |
1702 | Ascension transfers entire zones into GNS by doing incremental zone transfers | ||
1703 | and then adding the records to GNS. | ||
1704 | |||
1705 | You can find the source code here: @code{https://gnunet.org/git/ascension.git/} | ||
1702 | 1706 | ||
1703 | The software can be installed into a python virtual environment like this: | 1707 | The 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 | ||
1715 | The 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. | 1719 | The advantage of using a virtual environment is, that all the dependencies can |
1720 | be installed separately in different versions without touching your existing | ||
1721 | python installation and its dependencies. | ||
1716 | 1722 | ||
1717 | Using the tool is discussed in the user section of the documentation. | 1723 | Using 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 | ||
1919 | To migrate the Syrian top level domain - one of the few top level domains that still support zone transfers - use the following command: | 1919 | To 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 | ||
1925 | This will take a while but after it has finished executing the zone will have been migrated into GNS. | 1925 | The program will continue to run as a daemon and update once the refresh time specified in the zones SOA record has elapsed. |
1926 | 1926 | ||
1927 | The program will continue to run daemon and update once the refresh time specified in the zones SOA record has elapsed. | 1927 | At 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 | |||
1929 | At 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 |