diff --git a/ENVIRONMENT.rst b/ENVIRONMENT.rst index b7f3612..f6d5517 100644 --- a/ENVIRONMENT.rst +++ b/ENVIRONMENT.rst @@ -215,6 +215,7 @@ raise them. functioning Electrum clients by default will send pings roughly every 60 seconds. + Peer Discovery -------------- @@ -264,6 +265,49 @@ some of this. 9150 (Tor browser bundle) and 1080 (socks). +Server Advertising +------------------ + +These environment variables affect how your server is advertised, both +by peer discovery (if enabled) and IRC (if enabled). + +* **REPORT_HOST** + + The clearnet host to advertise. If not set, no clearnet host is + advertised. + +* **REPORT_TCP_PORT** + + The clearnet TCP port to advertise if **REPORT_HOST** is set. + Defaults to **TCP_PORT**. '0' disables publishing a TCP port. + +* **REPORT_SSL_PORT** + + The clearnet SSL port to advertise if **REPORT_HOST** is set. + Defaults to **SSL_PORT**. '0' disables publishing an SSL port. + +* **REPORT_HOST_TOR** + + If you wish run a Tor service, this is the Tor host name to + advertise and must end with `.onion`. + +* **REPORT_TCP_PORT_TOR** + + The Tor TCP port to advertise. The default is the clearnet + **REPORT_TCP_PORT**, unless disabled or it is '0', otherwise + **TCP_PORT**. '0' disables publishing a Tor TCP port. + +* **REPORT_SSL_PORT_TOR** + + The Tor SSL port to advertise. The default is the clearnet + **REPORT_SSL_PORT**, unless disabled or it is '0', otherwise + **SSL_PORT**. '0' disables publishing a Tor SSL port. + + **NOTE**: Certificate-Authority signed certificates don't work over + Tor, so you should set **REPORT_SSL_PORT_TOR** to 0 if yours is not + self-signed. + + IRC --- @@ -280,41 +324,8 @@ connectivity on IRC: **REPORT_HOST**. Either way a prefix will be prepended depending on **COIN** and **NET**. -* **REPORT_HOST** - - The host to advertise. Defaults to **HOST**. - -* **REPORT_TCP_PORT** - - The TCP port to advertise. Defaults to **TCP_PORT**. '0' disables - publishing the port. - -* **REPORT_SSL_PORT** - - The SSL port to advertise. Defaults to **SSL_PORT**. '0' disables - publishing the port. - -* **REPORT_HOST_TOR** - - The tor address to advertise; must end with `.onion`. If set, an - additional connection to IRC happens with '_tor' appended to - **IRC_NICK**. - -* **REPORT_TCP_PORT_TOR** - - The TCP port to advertise for Tor. Defaults to **REPORT_TCP_PORT**, - unless it is '0', otherwise **TCP_PORT**. '0' disables publishing - the port. - -* **REPORT_SSL_PORT_TOR** - - The SSL port to advertise for Tor. Defaults to **REPORT_SSL_PORT**, - unless it is '0', otherwise **SSL_PORT**. '0' disables publishing - the port. - - **NOTE**: Certificate-Authority signed certificates don't work over - Tor, so you should set **REPORT_SSL_PORT_TOR** to 0 if yours is not - self-signed. + If **REPORT_HOST_TOR** is set, an additional connection to IRC + happens with '_tor' appended to **IRC_NICK**. Cache