doc/README.html.in

   1 <?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4
   5 <head>
   6 <title>nss-myhostname @PACKAGE_VERSION@</title>
   7 <link rel="stylesheet" type="text/css" href="style.css" />
   8 </head>
   9
  10 <body>
  11 <h1><a name="top">nss-myhostname @PACKAGE_VERSION@</a></h1>
  12
  13 <p><i>Copyright 2005-2008 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>
  14
  15 <ul class="toc">
  16     <li><a href="#license">License</a></li>
  17     <li><a href="#news">News</a></li>
  18     <li><a href="#overview">Overview</a></li>
  19     <li><a href="#status">Current Status</a></li>
  20     <li><a href="#documentation">Documentation</a></li>
  21     <li><a href="#requirements">Requirements</a></li>
  22     <li><a href="#installation">Installation</a></li>
  23     <li><a href="#acks">Acknowledgements</a></li>
  24     <li><a href="#download">Download</a></li>
  25 </ul>
  26
  27 <h2><a name="license">License</a></h2>
  28
  29 <p>This program is free software; you can redistribute it and/or
  30 modify it under the terms of the GNU Lesser General Public License as
  31 published by the Free Software Foundation, either version 2.1 of the
  32 License, or (at your option) any later version.</p>
  33
  34 <p>This program is distributed in the hope that it will be useful, but
  35 WITHOUT ANY WARRANTY; without even the implied warranty of
  36 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  37 Lesser General Public License for more details.</p>
  38
  39 <h2><a name="news">News</a></h2>
  40
  41 <div class="news-date">Mon Oct 27 2008: </div>
  42
  43 <p class="news-text"><a
  44 href="@PACKAGE_URL@nss-myhostname-0.2.tar.gz">Version 0.2</a>
  45 released. Changes include: Update for IPv6 and newest glibc NSS interfaces</p>
  46
  47 <div class="news-date">Sat Nov 19 2005: </div>
  48
  49 <p class="news-text"><a
  50 href="@PACKAGE_URL@nss-myhostname-0.1.tar.gz">Version 0.1</a>
  51 released. Initial release.</p>
  52
  53 <h2><a name="overview">Overview</a></h2>
  54
  55 <p><tt>nss-myhostname</tt> is a plugin for the GNU Name Service Switch
  56 (NSS) functionality of the GNU C Library (<tt>glibc</tt>) providing
  57 host name resolution for the locally configured system hostname as
  58 returned by <tt>gethostname(2)</tt>. A lot of software relies on that the
  59 local host name is resolvable via DNS to an IPv4 or IPv6 address. When
  60 using dynamic hostnames this is usually achieved by
  61 patching <tt>/etc/hosts</tt> which however is suboptimal since it
  62 requires a writable <tt>/etc</tt> file system and is fragile because
  63 the file might also be edited by the
  64 administrator. <tt>nss-myhostname</tt> simply returns the IPv4
  65 address <tt>127.0.0.2</tt> (wich is on the local loopback) and the
  66 IPv6 address <tt>::1</tt> (which is the local host) for whatever
  67 system hostname is configured locally. Patching <tt>/etc/hostname</tt> is thus no longer necessary.</p>
  68
  69 <h2><a name="status">Current Status</a></h2>
  70
  71 <p>It works!</p>
  72
  73 <h2><a name="documentation">Documentation</a></h2>
  74
  75 <p>After compiling and installing <tt>nss-myhostname</tt> you'll find a
  76 new NSS modules in <tt>/lib</tt>:</p>
  77 <ul>
  78 <li><tt>libnss_myhostname.so.2</tt></li>
  79 </ul>
  80
  81 <p>To activate the NSS modules you have to edit
  82 <tt>/etc/nsswitch.conf</tt> and add <tt>myhostname</tt> to the
  83 line starting with "<tt>hosts:</tt>". On Debian this looks like
  84 this:</p>
  85
  86 <pre># /etc/nsswitch.conf
  87
  88 passwd:         compat
  89 group:          compat
  90 shadow:         compat
  91
  92 hosts:          files dns <b>myhostname</b>
  93 networks:       files
  94
  95 protocols:      db files
  96 services:       db files
  97 ethers:         db files
  98 rpc:            db files
  99
 100 netgroup:       nis</pre>
 101
 102 <p>That's it. You should now always be able to resolve your local
 103 system hostname. For a quick check
 104 use <tt>glibc</tt>'s <tt>getent</tt> tool:
 105
 106 <pre>$ getent ahosts `hostname`
 107 ::1             STREAM omega
 108 ::1             DGRAM
 109 ::1             RAW
 110 127.0.0.2       STREAM
 111 127.0.0.2       DGRAM
 112 127.0.0.2       RAW
 113 </pre>
 114
 115 <p>In this case the local host name is <i>omega</i>.</p>
 116
 117 <p>It is recommended to put <tt>myhostname</tt> last in
 118 the <tt>nsswitch.conf</tt> line to make sure that this mapping is only
 119 used as fallback, and any DNS or <tt>/etc/hosts</tt> based mapping takes
 120 precedence.</p>
 121
 122 <h2><a name="requirements">Requirements</a></h2>
 123
 124 <p><tt>nss-myhostname</tt> uses NSS interfaces that are specific to modern <tt>glibc</tt>'s.</p>
 125
 126 <p><tt>nss-myhostname</tt> was developed and tested on Fedora 10
 127 from October 2008, it should work on most other Linux
 128 distributions since it uses GNU autoconf and
 129 GNU libtool for source code configuration and shared library
 130 management.</p>
 131
 132 <h2><a name="installation">Installation</a></h2>
 133
 134 <p>As this package is made with the GNU autotools you should run
 135 <tt>./configure</tt> inside the distribution directory for configuring
 136 the source tree. After that you should run <tt>make</tt> for
 137 compilation and <tt>make install</tt> (as root) for installation of
 138 <tt>nss-myhostname</tt>.</p>
 139
 140 <h2><a name="acks">Acknowledgements</a></h2>
 141
 142 <p>None so far.</p>
 143
 144 <h2><a name="download">Download</a></h2>
 145
 146 <p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>
 147
 148 <p>The current release is <a href="@PACKAGE_URL@nss-myhostname-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
 149
 150 <p>Get <tt>nss-myhostname</tt>'s development sources from the <a href="http://git.or.cz/">GIT</a> <a href="git://git.0pointer.de/nss-myhostname">repository</a> (<a href="http://git.0pointer.de/?p=nss-myhostname.git">gitweb</a>): </p>
 151
 152 <pre>git clone git://git.0pointer.de/nss-myhostname</pre>
 153
 154 <hr/>
 155 <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, October 2008</address>
 156
 157 </body>
 158 </html>