summaryrefslogtreecommitdiff
path: root/man/nss-myhostname.xml
blob: 999d1afaf52cc69db234a198a57bd5b2d1f8bb0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2011 Lennart Poettering
  Copyright 2013 Tom Gundersen

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="nss-myhostname" conditional='HAVE_MYHOSTNAME'>

        <refentryinfo>
                <title>nss-myhostname</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>nss-myhostname</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>nss-myhostname</refname>
                <refpurpose>Provide hostname resolution for the locally
                configured system hostname.</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>libnss_myhostname.so.2</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>nss-myhostname</command> is a plugin
                for the GNU Name Service Switch (NSS) functionality of
                the GNU C Library (<command>glibc</command>) primarily
                providing hostname resolution for the locally
                configured system hostname as returned by
                <citerefentry><refentrytitle>gethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>. The
                precise hostnames resolved by this module are:</para>

                <itemizedlist>
                        <listitem><para>The local, configured hostname
                        is resolved to all locally configured public
                        IP addresses, or -- if none are configured --
                        the IPv4 address 127.0.0.2 (which is on the
                        local loopback) and the IPv6 address ::1
                        (which is the local host).</para></listitem>

                        <listitem><para>The hostname
                        <literal>localhost</literal> is resolved to
                        the IP addresses 127.0.0.1 and
                        ::1.</para></listitem>

                        <listitem><para>The hostname
                        <literal>gateway</literal> is resolved to all
                        current default routing gateway addresses,
                        ordered by their metric. This assigns a stable
                        hostname to the current gateway, useful for
                        referencing it independently of the current
                        network configuration state.</para></listitem>

                </itemizedlist>

                <para>Various software relies on an always-resolvable
                local hostname. When using dynamic hostnames, this is
                traditionally achieved by patching
                <filename>/etc/hosts</filename> at the same time as
                changing the hostname. This is problematic since it
                requires a writable <filename>/etc</filename> file
                system and is fragile because the file might be edited
                by the administrator at the same time. With
                <command>nss-myhostname</command> enabled changing
                <filename>/etc/hosts</filename> is unncessary, and on
                many systems the file becomes entirely optional.</para>

                <para>To activate the NSS modules,
                <literal>myhostname</literal> has to be added to the
                line starting with <literal>hosts:</literal> in
                <filename>/etc/nsswitch.conf</filename>.</para>

                <para>It is recommended to place
                <literal>myhostname</literal> last in the
                <filename>nsswitch.conf</filename> line to make sure
                that this mapping is only used as fallback, and any
                DNS or <filename>/etc/hosts</filename> based mapping
                takes precedence.</para>
        </refsect1>

        <refsect1>
                <title>Example</title>

                <para>Here's an example
                <filename>/etc/nsswitch.conf</filename> file, that
                enables <command>myhostname</command>
                correctly:</para>

<programlisting>passwd:         compat
group:          compat
shadow:         compat

hosts:          files dns <command>myhostname</command>
networks:       files

protocols:      db files
services:       db files
ethers:         db files
rpc:            db files

netgroup:       nis</programlisting>

                <para>To test, use <command>glibc</command>'s <command>getent</command> tool:</para>

                <programlisting>$ getent ahosts `hostname`
::1             STREAM omega
::1             DGRAM
::1             RAW
127.0.0.2       STREAM
127.0.0.2       DGRAM
127.0.0.2       RAW</programlisting>

                <para>In this case the local hostname is <varname>omega</varname>.</para>

        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>