diff options
author | rexxnor <rexxnor+gnunet@brief.li> | 2019-08-17 16:23:27 +0200 |
---|---|---|
committer | rexxnor <rexxnor+gnunet@brief.li> | 2019-08-17 16:32:13 +0200 |
commit | d83a189f76d278f61555b3a5b20ff0f89951ef27 (patch) | |
tree | 3f53eae54f2bf300612c6da66769fa8f1904142d /doc/handbook/chapters | |
parent | bf7912bb4d0f43182f4787c03c46c56dfa0105e3 (diff) | |
download | gnunet-d83a189f76d278f61555b3a5b20ff0f89951ef27.tar.gz gnunet-d83a189f76d278f61555b3a5b20ff0f89951ef27.zip |
updated documentation TODOs, added examples for MX and SOA record syntax
Diffstat (limited to 'doc/handbook/chapters')
-rw-r--r-- | doc/handbook/chapters/user.texi | 63 |
1 files changed, 62 insertions, 1 deletions
diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi index fcf5e7871..652863320 100644 --- a/doc/handbook/chapters/user.texi +++ b/doc/handbook/chapters/user.texi | |||
@@ -1015,7 +1015,7 @@ basically contain files using a file-sharing specific record type. | |||
1015 | 1015 | ||
1016 | Files (or directories) that have been signed and placed into a | 1016 | Files (or directories) that have been signed and placed into a |
1017 | namespace can be updated. Updates are identified as authentic if the | 1017 | namespace can be updated. Updates are identified as authentic if the |
1018 | same secret key was used to sign the update. | 1018 | same secret key was used to sign the update. |
1019 | 1019 | ||
1020 | @node Advertisements | 1020 | @node Advertisements |
1021 | @subsubsection Advertisements | 1021 | @subsubsection Advertisements |
@@ -1704,6 +1704,7 @@ nameserver, i.e. | |||
1704 | 1704 | ||
1705 | @example | 1705 | @example |
1706 | Name: pet; RRType: GNS2DNS; Value: gnunet.org@@ns-joker.+@ | 1706 | Name: pet; RRType: GNS2DNS; Value: gnunet.org@@ns-joker.+@ |
1707 | |||
1707 | Name: ns-joker; RRType: A; Value: 184.172.157.218 | 1708 | Name: ns-joker; RRType: A; Value: 184.172.157.218 |
1708 | @end example | 1709 | @end example |
1709 | 1710 | ||
@@ -1734,64 +1735,124 @@ should use the ZKEY zone as the destination hostname and | |||
1734 | GNS-enabled mail servers should be configured to accept | 1735 | GNS-enabled mail servers should be configured to accept |
1735 | e-mails to the ZKEY-zones of all local users. | 1736 | e-mails to the ZKEY-zones of all local users. |
1736 | 1737 | ||
1738 | To add a SOA record via the gnunet-namestore command line | ||
1739 | tool use the following syntax for the value option. Choose | ||
1740 | the other options according to your preference, however in | ||
1741 | this example we will use a relative expiry, add the record | ||
1742 | under the label @ and add the records to the zone bar | ||
1743 | which already exists: | ||
1744 | |||
1745 | @example | ||
1746 | $ gnunet-namestore -a -n @ -t SOA -z bar -e 3600s -V \ | ||
1747 | > "rname=$PRIMARY_NS \ | ||
1748 | > mname=$CONTACT_MAIL \ | ||
1749 | > $SERIAL,$REFRESH,$RETRY,$EXPIRY,$MINIMUM_TTL" | ||
1750 | @end example | ||
1751 | |||
1752 | The above command filled in with values looks like this: | ||
1753 | @example | ||
1754 | $ gnunet-namestore -a -n @ -t SOA -z bar -e 3600s -V \ | ||
1755 | > "rname=ns1.bar \ | ||
1756 | > mname=root.bar \ | ||
1757 | > 2019081701,3600,1800,86400,7200" | ||
1758 | @end example | ||
1759 | |||
1760 | MX records use a similar syntax which is outlined in the | ||
1761 | example below. $SERVER is a domain name as mentioned above. | ||
1762 | @example | ||
1763 | $ gnunet-namestore -a -n mail -t MX -z bar -e 3600s -V \ | ||
1764 | > "$PRIORITY,$SERVER" | ||
1765 | @end example | ||
1766 | |||
1767 | With the values substituted this is an example of a working | ||
1768 | command: | ||
1769 | @example | ||
1770 | $ gnunet-namestore -a -n mail -t MX -z bar -e 3600s -V \ | ||
1771 | > "10,mail.bar" | ||
1772 | @end example | ||
1773 | |||
1737 | @node PLACE | 1774 | @node PLACE |
1738 | @subsubsection PLACE | 1775 | @subsubsection PLACE |
1739 | 1776 | ||
1777 | @c TODO describe record type and give an example of how and | ||
1778 | @c when to use it | ||
1740 | Record type for a social place. | 1779 | Record type for a social place. |
1741 | 1780 | ||
1742 | @node PHONE | 1781 | @node PHONE |
1743 | @subsubsection PHONE | 1782 | @subsubsection PHONE |
1744 | 1783 | ||
1784 | @c TODO describe record type and give an example of how and | ||
1785 | @c when to use it | ||
1745 | Record type for a phone (of CONVERSATION). | 1786 | Record type for a phone (of CONVERSATION). |
1746 | 1787 | ||
1747 | @node ID ATTR | 1788 | @node ID ATTR |
1748 | @subsubsection ID ATTR | 1789 | @subsubsection ID ATTR |
1749 | 1790 | ||
1791 | @c TODO describe record type and give an example of how and | ||
1792 | @c when to use it | ||
1750 | Record type for identity attributes (of IDENTITY). | 1793 | Record type for identity attributes (of IDENTITY). |
1751 | 1794 | ||
1752 | @node ID TOKEN | 1795 | @node ID TOKEN |
1753 | @subsubsection ID TOKEN | 1796 | @subsubsection ID TOKEN |
1754 | 1797 | ||
1798 | @c TODO describe record type and give an example of how and | ||
1799 | @c when to use it | ||
1755 | Record type for an identity token (of IDENTITY-TOKEN). | 1800 | Record type for an identity token (of IDENTITY-TOKEN). |
1756 | 1801 | ||
1757 | @node ID TOKEN METADATA | 1802 | @node ID TOKEN METADATA |
1758 | @subsubsection ID TOKEN METADATA | 1803 | @subsubsection ID TOKEN METADATA |
1759 | 1804 | ||
1805 | @c TODO describe record type and give an example of how and | ||
1806 | @c when to use it | ||
1760 | Record type for the private metadata of an identity token (of IDENTITY-TOKEN). | 1807 | Record type for the private metadata of an identity token (of IDENTITY-TOKEN). |
1761 | 1808 | ||
1762 | @node CREDENTIAL | 1809 | @node CREDENTIAL |
1763 | @subsubsection CREDENTIAL | 1810 | @subsubsection CREDENTIAL |
1764 | 1811 | ||
1812 | @c TODO describe record type and give an example of how and | ||
1813 | @c when to use it | ||
1765 | Record type for credential. | 1814 | Record type for credential. |
1766 | 1815 | ||
1767 | @node POLICY | 1816 | @node POLICY |
1768 | @subsubsection POLICY | 1817 | @subsubsection POLICY |
1769 | 1818 | ||
1819 | @c TODO describe record type and give an example of how and | ||
1820 | @c when to use it | ||
1770 | Record type for policies. | 1821 | Record type for policies. |
1771 | 1822 | ||
1772 | @node ATTRIBUTE | 1823 | @node ATTRIBUTE |
1773 | @subsubsection ATTRIBUTE | 1824 | @subsubsection ATTRIBUTE |
1774 | 1825 | ||
1826 | @c TODO describe record type and give an example of how and | ||
1827 | @c when to use it | ||
1775 | Record type for reverse lookups. | 1828 | Record type for reverse lookups. |
1776 | 1829 | ||
1777 | @node ABE KEY | 1830 | @node ABE KEY |
1778 | @subsubsection ABE KEY | 1831 | @subsubsection ABE KEY |
1779 | 1832 | ||
1833 | @c TODO describe record type and give an example of how and | ||
1834 | @c when to use it | ||
1780 | Record type for ABE records. | 1835 | Record type for ABE records. |
1781 | 1836 | ||
1782 | @node ABE MASTER | 1837 | @node ABE MASTER |
1783 | @subsubsection ABE MASTER | 1838 | @subsubsection ABE MASTER |
1784 | 1839 | ||
1840 | @c TODO describe record type and give an example of how and | ||
1841 | @c when to use it | ||
1785 | Record type for ABE master keys. | 1842 | Record type for ABE master keys. |
1786 | 1843 | ||
1787 | @node RECLAIM OIDC CLIENT | 1844 | @node RECLAIM OIDC CLIENT |
1788 | @subsubsection RECLAIM OIDC CLIENT | 1845 | @subsubsection RECLAIM OIDC CLIENT |
1789 | 1846 | ||
1847 | @c TODO describe record type and give an example of how and | ||
1848 | @c when to use it | ||
1790 | Record type for reclaim OIDC clients. | 1849 | Record type for reclaim OIDC clients. |
1791 | 1850 | ||
1792 | @node RECLAIM OIDC REDIRECT | 1851 | @node RECLAIM OIDC REDIRECT |
1793 | @subsubsection RECLAIM OIDC REDIRECT | 1852 | @subsubsection RECLAIM OIDC REDIRECT |
1794 | 1853 | ||
1854 | @c TODO describe record type and give an example of how and | ||
1855 | @c when to use it | ||
1795 | Record type for reclaim OIDC redirect URIs. | 1856 | Record type for reclaim OIDC redirect URIs. |
1796 | 1857 | ||
1797 | @node Synchronizing with legacy DNS | 1858 | @node Synchronizing with legacy DNS |