Commit 2f4fcfc8 authored by Nick Mathewson's avatar Nick Mathewson 🤹
Browse files

manpage: Move more authority-only options into the authority section

I don't know whether we missed these or misclassified them when we
first made the "DIRECTORY AUTHORITY SERVER OPTIONS" section, but they
really belong there.
parent 9b10d7a7
Loading
Loading
Loading
Loading
+4 −0
Original line number Original line Diff line number Diff line
   o Documentation:
     - In the manpage, move more authority-only options into the
       directory authority section so that operators of regular
       directory caches don't get confused.
+44 −39
Original line number Original line Diff line number Diff line
@@ -1761,56 +1761,17 @@ DIRECTORY SERVER OPTIONS
The following options are useful only for directory servers (that is,
The following options are useful only for directory servers (that is,
if DirPort is non-zero):
if DirPort is non-zero):


[[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
    When this option is set to 1, Tor operates as an authoritative directory
    server. Instead of caching the directory, it generates its own list of
    good servers, signs it, and sends that to the clients. Unless the clients
    already have you listed as a trusted directory, you probably do not want
    to set this option. Please coordinate with the other admins at
    tor-ops@torproject.org if you think you should be a directory.

[[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
[[DirPortFrontPage]] **DirPortFrontPage** __FILENAME__::
    When this option is set, it takes an HTML file and publishes it as "/" on
    When this option is set, it takes an HTML file and publishes it as "/" on
    the DirPort. Now relay operators can provide a disclaimer without needing
    the DirPort. Now relay operators can provide a disclaimer without needing
    to set up a separate webserver. There's a sample disclaimer in
    to set up a separate webserver. There's a sample disclaimer in
    contrib/operator-tools/tor-exit-notice.html.
    contrib/operator-tools/tor-exit-notice.html.


[[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
    When this option is set in addition to **AuthoritativeDirectory**, Tor
    generates version 3 network statuses and serves descriptors, etc as
    described in doc/spec/dir-spec.txt (for Tor clients and servers running at
    least 0.2.0.x).

[[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
    When this option is set to 1, Tor adds information on which versions of
    Tor are still believed safe for use to the published directory. Each
    version 1 authority is automatically a versioning authority; version 2
    authorities provide this service optionally. See **RecommendedVersions**,
    **RecommendedClientVersions**, and **RecommendedServerVersions**.

[[NamingAuthoritativeDirectory]] **NamingAuthoritativeDirectory** **0**|**1**::
    When this option is set to 1, then the server advertises that it has
    opinions about nickname-to-fingerprint bindings. It will include these
    opinions in its published network-status pages, by listing servers with
    the flag "Named" if a correct binding between that nickname and fingerprint
    has been registered with the dirserver. Naming dirservers will refuse to
    accept or publish descriptors that contradict a registered binding. See
    **approved-routers** in the **FILES** section below.

[[HidServDirectoryV2]] **HidServDirectoryV2** **0**|**1**::
[[HidServDirectoryV2]] **HidServDirectoryV2** **0**|**1**::
    When this option is set, Tor accepts and serves v2 hidden service
    When this option is set, Tor accepts and serves v2 hidden service
    descriptors. Setting DirPort is not required for this, because clients
    descriptors. Setting DirPort is not required for this, because clients
    connect via the ORPort by default. (Default: 1)
    connect via the ORPort by default. (Default: 1)


[[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
    When this option is set in addition to **AuthoritativeDirectory**, Tor
    accepts and serves router descriptors, but it caches and serves the main
    networkstatus documents rather than generating its own. (Default: 0)

[[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
    Minimum uptime of a v2 hidden service directory to be accepted as such by
    authoritative directories. (Default: 25 hours)

[[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
[[DirPort]] **DirPort** \['address':]__PORT__|**auto** [_flags_]::
    If this option is nonzero, advertise the directory service on this port.
    If this option is nonzero, advertise the directory service on this port.
    Set it to "auto" to have Tor pick a port for you.  This option can occur
    Set it to "auto" to have Tor pick a port for you.  This option can occur
@@ -1838,6 +1799,41 @@ if DirPort is non-zero):
DIRECTORY AUTHORITY SERVER OPTIONS
DIRECTORY AUTHORITY SERVER OPTIONS
----------------------------------
----------------------------------


The following options enable operation as a directory authority, and
control how Tor behaves as a directory authority.  You should not need
to adjust any of them if you're running a regular relay or exit server
on the public Tor network.

[[AuthoritativeDirectory]] **AuthoritativeDirectory** **0**|**1**::
    When this option is set to 1, Tor operates as an authoritative directory
    server. Instead of caching the directory, it generates its own list of
    good servers, signs it, and sends that to the clients. Unless the clients
    already have you listed as a trusted directory, you probably do not want
    to set this option. Please coordinate with the other admins at
    tor-ops@torproject.org if you think you should be a directory.

[[V3AuthoritativeDirectory]] **V3AuthoritativeDirectory** **0**|**1**::
    When this option is set in addition to **AuthoritativeDirectory**, Tor
    generates version 3 network statuses and serves descriptors, etc as
    described in doc/spec/dir-spec.txt (for Tor clients and servers running at
    least 0.2.0.x).

[[VersioningAuthoritativeDirectory]] **VersioningAuthoritativeDirectory** **0**|**1**::
    When this option is set to 1, Tor adds information on which versions of
    Tor are still believed safe for use to the published directory. Each
    version 1 authority is automatically a versioning authority; version 2
    authorities provide this service optionally. See **RecommendedVersions**,
    **RecommendedClientVersions**, and **RecommendedServerVersions**.

[[NamingAuthoritativeDirectory]] **NamingAuthoritativeDirectory** **0**|**1**::
    When this option is set to 1, then the server advertises that it has
    opinions about nickname-to-fingerprint bindings. It will include these
    opinions in its published network-status pages, by listing servers with
    the flag "Named" if a correct binding between that nickname and fingerprint
    has been registered with the dirserver. Naming dirservers will refuse to
    accept or publish descriptors that contradict a registered binding. See
    **approved-routers** in the **FILES** section below.

[[RecommendedVersions]] **RecommendedVersions** __STRING__::
[[RecommendedVersions]] **RecommendedVersions** __STRING__::
    STRING is a comma-separated list of Tor versions currently believed to be
    STRING is a comma-separated list of Tor versions currently believed to be
    safe. The list is included in each directory, and nodes which pull down the
    safe. The list is included in each directory, and nodes which pull down the
@@ -1852,6 +1848,15 @@ DIRECTORY AUTHORITY SERVER OPTIONS
    is used. When this is set then **VersioningAuthoritativeDirectory** should
    is used. When this is set then **VersioningAuthoritativeDirectory** should
    be set too.
    be set too.


[[BridgeAuthoritativeDir]] **BridgeAuthoritativeDir** **0**|**1**::
    When this option is set in addition to **AuthoritativeDirectory**, Tor
    accepts and serves router descriptors, but it caches and serves the main
    networkstatus documents rather than generating its own. (Default: 0)

[[MinUptimeHidServDirectoryV2]] **MinUptimeHidServDirectoryV2** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
    Minimum uptime of a v2 hidden service directory to be accepted as such by
    authoritative directories. (Default: 25 hours)

[[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
[[RecommendedServerVersions]] **RecommendedServerVersions** __STRING__::
    STRING is a comma-separated list of Tor versions currently believed to be
    STRING is a comma-separated list of Tor versions currently believed to be
    safe for servers to use. This information is included in version 2
    safe for servers to use. This information is included in version 2