Committer: Miika Komu <miika@xxxxxx> Date: 16/03/2010 at 14:24:00 Revision: 3950 Revision-id: miika@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Branch nick: trunk Log: Updated manual regarding to different methods of using HIP. Clarified hosts files usage. Adjusted examples of using conntest-client-hip (use of /etc/hip/hosts requires now DNS proxy). Modified: M doc/HOWTO.xml === modified file 'doc/HOWTO.xml' --- doc/HOWTO.xml 2010-03-14 15:12:47 +0000 +++ doc/HOWTO.xml 2010-03-16 12:23:58 +0000 @@ -2108,15 +2108,15 @@ /etc/hosts: </para></listitem> <listitem><para> + HIT_OF_OOPS oops + </para></listitem> + <listitem><para> + /etc/hosts: + </para></listitem> + <listitem><para> 3ffe::2 oops </para></listitem> <listitem><para> - /etc/hip/hosts: - </para></listitem> - <listitem><para> - HIT_OF_OOPS oops - </para></listitem> - <listitem><para> ifconfig eth0 inet6 add 3ffe::1/64 </para></listitem> <listitem><para> @@ -2256,7 +2256,7 @@ <itemizedlist> <listitem> <para> - Add the information in /etc/hip/hosts + Add the information in /etc/hosts <itemizedlist> <listitem><para>OOPS_HIT oops</para></listitem> <listitem><para>OOPS_LSI oops <emphasis>Optional!</emphasis> If it's not defined, @@ -2410,53 +2410,54 @@ <section id="sec_easy_methods"> <title>Easy Methods</title> <para> - 1. Run the dnshipproxy to handle mapping from hostnames to HITs from hosts files. + 1. Run the dnshipproxy to map hostnames transparently to HITs from hosts files and directory services (DNS, DHT). See <xref linkend="sec_dns_proxy" /> for more details. </para> <para> - 2. Use external nameservices for HIT-IP mapping, such as HIP DNS records - as instructed in <xref linkend="ch_dns_data" /> (requires the use of the DNS proxy). - Alternatively, use the free DHT name service for automatic host - naming as described in <xref linkend="ch_opendht" />. - </para> - <para> - 4. You can also use HITs (or LSIs) directly in the application. For example, you can - do "ping6 PEER_HIT". However, hipd must know the mapping from the - PEER_HIT to the corresponding IP address. You can tell this mapping to - hipd using several ways. First way is to configure the HIT-hostname - pair to /etc/hip/hosts and the IP-hostname pair to /etc/hosts. Second - way is execute "hipconf add map PEER_HIT PEER_IP". You can insert the - hipconf command also to /etc/hip/hipd_config and restart hipd when you - want the mapping to be permanent. - </para> - <para> - 5. Overload your /etc/hosts files by adding HITs or LSIs to the - file and use the hostname in your application. The file should contain also - the IP addresses with the same hostname as HITs and LSIs. - </para> - <para> - 6. Use the opportunistic mode as described in + 2. Overload your /etc/hosts files by adding HITs or LSIs before the + corresponding IP addresses. This method does not require + DNS proxy running on the host and works using hostnames. + </para> + <para> + 3. You can also use HITs (or LSIs) directly in the application. + For example, you can + execute "ping6 PEER_HIT". However, hipd must know the mapping from the + PEER_HIT to the corresponding IP address. Hipd can find this mapping + from DNS or DHT. Alternatively, this information can be store to + hosts files as follows: + </para> + <para> + 3a. If you want to maintain separate files for HIP identifiers, + write the HIT-hostname (or LSI-hostname) + pair to /etc/hip/hosts and the IP-hostname pair to /etc/hosts. + See also the method (2) for overloading all addresses in + /etc/hosts. + </para> + <para> + 3b. Execute "hipconf add map PEER_HIT PEER_IP" and use the HIT directly + in the application. You can insert the + hipconf command also to /etc/hip/hipd_config and restart hipd. + </para> + </section> + <section id="sec_advanced_methods"> + <title>Experimental Methods</title> + <para> + These methods are experimental. Use with care and only if you know what you are doing! + </para> + <para> + 1. Use the opportunistic mode as described in <xref linkend="opportunistic" />. This method works with both IPv4 and IPv6 applications. It does not require HIT configuration at all. </para> <para> - 6a. Running a single IPv6-enabled application using HIP: <emphasis>hipconf run opp <EXECUTABLE></emphasis> - </para> - <para> - 6b. Enabling HIP for all applications in bash shell (add to bashrc if you want to set this permanently): <emphasis>export LD_PRELOAD=libopphip.so:libhiptool.so:libhipopendht.so</emphasis> - </para> - </section> - <section id="sec_advanced_methods"> - <title>Advanced Methods</title> - <para>These methods assume that you have the source code available - for the application and the application is IPv6 enabled. You have - to relink the application to use the HIP libraries and, - in some methods, to modify the source code. - </para> - <para> - Following applications are IPv6 enabled (and use getaddrinfo for name - resolution): telnet, firefox, lynx, ssh. Not using getaddrinfo: ping, - ping6, tla, svn. + 1a. Running a single IPv6-enabled application using HIP: <emphasis>hipconf run opp <EXECUTABLE></emphasis> + </para> + <para> + 1b. Enabling HIP for all applications in bash shell (add to bashrc if you want to set this permanently): <emphasis>export LD_PRELOAD=libopphip.so:libhiptool.so:libhipopendht.so</emphasis> + </para> + <para> + 2. Use the system-based opportunistic mode as instructed in + <xref linkend="sys_based_opp_mode" />. </para> </section> @@ -2655,7 +2656,7 @@ <para> The name can be something found from <emphasis>/etc/hosts</emphasis> - and <emphasis>/etc/hip/hosts</emphasis> or you can use DHT to + and <emphasis>/etc/hosts</emphasis> or you can use DHT to resolve names to HIT and address. Search can also be done directly with HIT by command </para> @@ -3013,6 +3014,7 @@ Currently HIP daemon performs name resolution in the following order: <itemizedlist> <listitem><para>in /etc/hip/hosts</para></listitem> + <listitem><para>in /etc/hosts</para></listitem> <listitem><para>in hit-to-ip.infrahip.net zone</para></listitem> <listitem><para>in DHT</para></listitem> </itemizedlist> @@ -4806,7 +4808,7 @@ </section> <section id="sys_based_opp_mode"> - <title>System-based opportunistic mode</title> + <title>System-based opportunistic mode (experimental)</title> <para> The system-based opportunistic mode enables HIP communication without the use of the opportunistic library. If the peer does