mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-03-03 10:46:58 +01:00
Code Issues Projects Releases Wiki Activity

doc: make it clearer that specifying addr etc disables autolisten.

Browse source 
Reported-by: Greg Sanders
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2018-11-21 07:13:38 +10:30
parent 47743a287c
commit 56fd2541c3
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/lightningd-config.5
View file

@ -2,12 +2,12 @@
.\" Title: lightningd-config .\" Title: lightningd-config
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 10/12/2018 .\" Date: 11/21/2018
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNINGD\-CONFIG" "5" "10/12/2018" "\ \&" "\ \&" .TH "LIGHTNINGD\-CONFIG" "5" "11/21/2018" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -278,7 +278,7 @@ Networking options:
.sp .sp
Note that for simple setups, the implicit \fIautolisten\fR option does the right thing: it will try to bind to port 9735 on IPv4 and IPv6, and will announce it to peers if it\(cqs seems like a public address\&. Note that for simple setups, the implicit \fIautolisten\fR option does the right thing: it will try to bind to port 9735 on IPv4 and IPv6, and will announce it to peers if it\(cqs seems like a public address\&.
.sp .sp
You can instead use \fIaddr\fR to override this (eg\&. to change the port), or precisely control where to bind and what to announce with the \fIbind\-addr\fR and \fIannounce\-addr\fR options\&. You can instead use \fIaddr\fR to override this (eg\&. to change the port), or precisely control where to bind and what to announce with the \fIbind\-addr\fR and \fIannounce\-addr\fR options\&. These will \fBdisable\fR the \fIautolisten\fR logic, so you must specifiy exactly what you want!
.PP .PP
\fBaddr\fR=\fI[IPADDRESS[:PORT]]|autotor:TORIPADDRESS[:TORPORT]\fR \fBaddr\fR=\fI[IPADDRESS[:PORT]]|autotor:TORIPADDRESS[:TORPORT]\fR
.RS 4 .RS 4

3
doc/lightningd-config.5.txt
View file

@ -218,7 +218,8 @@ will announce it to peers if it's seems like a public address.
You can instead use 'addr' to override this (eg. to change the port), You can instead use 'addr' to override this (eg. to change the port),
or precisely control where to bind and what to announce with the or precisely control where to bind and what to announce with the
'bind-addr' and 'announce-addr' options. 'bind-addr' and 'announce-addr' options. These will *disable* the
'autolisten' logic, so you must specifiy exactly what you want!
*addr*='[IPADDRESS[:PORT]]|autotor:TORIPADDRESS[:TORPORT]':: *addr*='[IPADDRESS[:PORT]]|autotor:TORIPADDRESS[:TORPORT]'::