mirror of
https://github.com/cculianu/Fulcrum.git
synced 2026-08-13 12:33:27 +02:00
Updated documentation/example config/etc for the new upnp option.
This commit is contained in:
Calin Culianu
parent
426d9f3c85
commit
61c992f7ec
3 changed files with 60 additions and 25 deletions
|
|
@ -339,6 +339,26 @@ rpcpassword = hunter1
|
|||
#anon_logs = false
|
||||
|
||||
|
||||
# UPnP support - 'upnp' - DEFAULT: false (disabled).
|
||||
|
||||
# Tells Fulcrum to use UPnP to open up and/or map firewall ports. Requires that
|
||||
# Fulcrum be compiled with `miniupnpc` library support enabled (this is the
|
||||
# case for the author-published static builds).
|
||||
#
|
||||
# This option is useful for servers behind NAT firewalls. Specifies that
|
||||
# Fulcrum should contact your router and/or internet gateway and ask it to open
|
||||
# up ports for all specified non-loopback tcp/ssl/ws/wss ports that Fulcrum is
|
||||
# listening on.
|
||||
#
|
||||
# Note: In addition, this option interacts with the configuration options
|
||||
# `public_*_port` in that if those ports differ from internal ports (as
|
||||
# specified by the `tcp`/`ssl`/`ws`/`wss` options), Fulcrum will intelligently
|
||||
# ask the router to map the specified public ports to the (potentially
|
||||
# different) specified internal ports.
|
||||
#
|
||||
#upnp = true
|
||||
|
||||
|
||||
#-------------------------------------------------------------------------------
|
||||
# PEER DISCOVERY AND PUBLIC SERVER OPTIONS
|
||||
#-------------------------------------------------------------------------------
|
||||
|
|
@ -367,12 +387,12 @@ rpcpassword = hunter1
|
|||
# The server's public TCP port. This, along with 'hostname' and the various
|
||||
# 'public_*_port' variables are announced to clients and to other servers
|
||||
# engaged in peer discovery. The default for this variable is to simply use the
|
||||
# first TCP port specified in the server configuration (if any). If you are
|
||||
# behind a firewall and doing some port remapping, then you definitely want to
|
||||
# set this option. This should be the public TCP port as would be used by the
|
||||
# rest of the internet to connect to your server via an unencrypted TCP
|
||||
# connection (non-SSL). You may also set this option to 0 to disable reporting
|
||||
# any TCP port.
|
||||
# first non-loopback TCP port specified in the server configuration (if any).
|
||||
# If you are behind a firewall and doing some port remapping, then you
|
||||
# definitely want to set this option. This should be the public TCP port as
|
||||
# would be used by the rest of the internet to connect to your server via an
|
||||
# unencrypted TCP connection (non-SSL). You may also set this option to 0 to
|
||||
# disable reporting any TCP port. See also: `tcp`, `tor_tcp_port`, `upnp`.
|
||||
#
|
||||
#public_tcp_port = 50001
|
||||
|
||||
|
|
@ -382,11 +402,12 @@ rpcpassword = hunter1
|
|||
# The server's public SSL port. This, along with 'hostname' and the various
|
||||
# 'public_*_port' variables are announced to clients and to other servers
|
||||
# engaged in peer discovery. The default for this variable is to simply use the
|
||||
# first SSL port specified in the server configuration (if any). If you are
|
||||
# behind a firewall and doing some port remapping, then you definitely want to
|
||||
# set this option. This should be the public SSL port as would be used by the
|
||||
# rest of the internet to connect to your server via SSL. You may also set this
|
||||
# option to 0 to disable reporting any SSL port.
|
||||
# first non-loopback SSL port specified in the server configuration (if any).
|
||||
# If you are behind a firewall and doing some port remapping, then you
|
||||
# definitely want to set this option. This should be the public SSL port as
|
||||
# would be used by the rest of the internet to connect to your server via SSL.
|
||||
# You may also set this option to 0 to disable reporting any SSL port. See
|
||||
# also: `ssl`, `tor_ssl_port`, `upnp`.
|
||||
#
|
||||
#public_ssl_port = 50002
|
||||
|
||||
|
|
@ -396,12 +417,12 @@ rpcpassword = hunter1
|
|||
# The server's public WS (Web Socket) port. This, along with 'hostname' and the
|
||||
# various 'public_*_port' variables are announced to clients and to other servers
|
||||
# engaged in peer discovery. The default for this variable is to simply use the
|
||||
# first WS port specified in the server configuration (if any). If you are
|
||||
# behind a firewall and doing some port remapping, then you definitely want to
|
||||
# set this option. This should be the public WS port as would be used by the
|
||||
# rest of the internet to connect to your server via an unencrypted Web Socket
|
||||
# (ws://) connection. You may also set this option to 0 to disable reporting any
|
||||
# WS port. See also: ws, tor_ws_port
|
||||
# first non-loopback WS port specified in the server configuration (if any). If
|
||||
# you are behind a firewall and doing some port remapping, then you definitely
|
||||
# want to set this option. This should be the public WS port as would be used
|
||||
# by the rest of the internet to connect to your server via an unencrypted Web
|
||||
# Socket (ws://) connection. You may also set this option to 0 to disable
|
||||
# reporting any WS port. See also: `ws`, `tor_ws_port`, `upnp`.
|
||||
#
|
||||
#public_ws_port = 50003
|
||||
|
||||
|
|
@ -411,12 +432,13 @@ rpcpassword = hunter1
|
|||
# The server's public WSS (Web Socket Secure) port. This, along with 'hostname'
|
||||
# and the various 'public_*_port' variables are announced to clients and to other
|
||||
# servers engaged in peer discovery. The default for this variable is to simply
|
||||
# use the first WSS port specified in the server configuration (if any). If you
|
||||
# are behind a firewall and doing some port remapping, then you definitely want
|
||||
# to set this option. This should be the public WSS port as would be used by the
|
||||
# rest of the internet to connect to your server via an encrypted Web Socket
|
||||
# Secure (wss://) connection. You may also set this option to 0 to disable
|
||||
# reporting any WSS port. See also: wss, tor_wss_port
|
||||
# use the first non-loopback WSS port specified in the server configuration (if
|
||||
# any). If you are behind a firewall and doing some port remapping, then you
|
||||
# definitely want to set this option. This should be the public WSS port as
|
||||
# would be used by the rest of the internet to connect to your server via an
|
||||
# encrypted Web Socket Secure (wss://) connection. You may also set this option
|
||||
# to 0 to disable reporting any WSS port. See also: `wss`, `tor_wss_port`,
|
||||
# `upnp`.
|
||||
#
|
||||
#public_wss_port = 50004
|
||||
|
||||
|
|
|
|||
|
|
@ -54,6 +54,16 @@ ws = 0.0.0.0:50003
|
|||
# presence of this variable requires key= and cert= both be specified.
|
||||
wss = 0.0.0.0:50004
|
||||
|
||||
# Enable UPnP support - 'upnp' - DEFAULT: false (disabled). Useful for servers
|
||||
# behind NAT firewalls. Specifies that Fulcrum should contact your router
|
||||
# ask it to open up ports for all specified (non-looopback) tcp/ssl/ws/wss
|
||||
# ports that Fulcrum is listening on. Note this option also interacts with the
|
||||
# configuration options `public_*_port` in that if those ports differ from
|
||||
# internal ports (as specified by the tcp/ssl/ws/wss options), Fulcrum will
|
||||
# intelligently ask the router to map the specified public ports to the
|
||||
# (potentially different) specified internal ports.
|
||||
#upnp = true
|
||||
|
||||
# SSL cert. - 'cert' - DEFAULT: None (required for SSL) (PEM, self-signed ok)
|
||||
cert = /path/to/server-cert.pem
|
||||
|
||||
|
|
|
|||
|
|
@ -125,10 +125,13 @@ Once the server finishes synching it will behave like an ElectronX/ElectrumX ser
|
|||
: If specified, Fulcrum will use a UTXO Cache that consumes extra memory but syncs up to to 2X faster. To use this feature, you must specify a memory value in MB to allocate to the cache. It is recommended that you give this facility at least 500 MB for it to really pay off, although any amount of memory given (minimum 64 MB) should be beneficial. Note that this feature is currently experimental and the tradeoffs are: it is faster because it avoids redundant disk I/O, however, this comes at the price of considerable memory consumption as well as a sync that is less resilient to crashes mid-sync. If the process is killed mid-sync, the database may become corrupt and lose UTXO data. Use this feature only if you are 100% sure that won't happen during a sync. The default is off (0). This option only takes effect on initial sync, otherwise this option has no effect.
|
||||
|
||||
--rpa
|
||||
: Explicitly enable the Reusable Payment Address index and offer the associated "blockchain.rpa.*" RPC methods to clients. To explicitly disable this facility, use the CLI arg --no-rpa. Default is: auto (enabled for BCH only).
|
||||
: Explicitly enable the Reusable Payment Address index and offer the associated "blockchain.rpa.*" RPC methods to clients. To explicitly disable this facility, use the CLI arg --no-rpa. Default is: auto (enabled for BCH only).
|
||||
|
||||
--upnp
|
||||
: Use UPnP to tell your router to automatically allow incoming connections for all all TCP, SSL, WS, and WSS ports. To explicitly disable UPnP, use the CLI arg --no-upnp. Default is: disabled.
|
||||
|
||||
--dump-sh <outputfile>
|
||||
: *This is an advanced debugging option*. Dump script hashes. If specified, after the database is loaded, all of the script hashes in the database will be written to outputfile as a JSON array.
|
||||
: *This is an advanced debugging option*. Dump script hashes. If specified, after the database is loaded, all of the script hashes in the database will be written to outputfile as a JSON array.
|
||||
|
||||
[config]
|
||||
: Configuration file (optional). To read configuration variables from the environment instead, specify `_ENV_` for this argument.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue