Fulcrum/doc/fulcrum-quick-config.conf

# Quickstart Example Configuration File for Fulcrum
#
# This file is a quick sample config that has brief comments for the basic
# options offered by Fulcrum. For a more complete description of all the
# possible configuration variables, please see "fulcrum-example-config.conf"
# from the doc/ directory of the Fulcrum source code.
#-------------------------------------------------------------------------------

# *REQUIRED* This is your database directory. The mountpoint needs about 35GB
# free space if synching to mainnet and 8GB free space if synching to testnet.
# NOTE: Use native path separators: '/' on Unix, '\' on Windows.
datadir = /path/to/a/dir  # Windows: datadir = D:\FulcrumData\mainnet

# *REQUIRED* This is the bitcoind RPC socket you configured using rpcbind= and
# rpcport= in your bitcoind .conf file.
bitcoind = 127.0.0.1:8332

# *OPTIONAL* Use this option to connect to bitcoind via HTTPS rather than the
# usual HTTP. This option typically is only used with `bchd`.
#bitcoind-tls = true

# This is the bitcoind RPC username you specified in your bitcoind .conf file.
# This corresponds to the rpcuser= from that file. If using the auto-generated
# cookie file from bitcoind, specify rpccookie= instead (see below).
rpcuser = Bob_The_Banker

# This is the bitcoind RPC password you specified in your bitcoind .conf file.
# This corresponds to the rpcpassword= from that file. If using the
# auto-generated cookie file from bitcoind, specify rpccookie= instead (see
# below).
rpcpassword = hunter1

# An alternative to using rpcuser= and rpcpassword= is to use .cookie file
# authentication. This should the full path to your .cookie file in your
# bitcoind datadir. Do not specify this at the same time as "rpcuser" and
# "rpcpassword"
#rpccookie = /path/to/bitcoind/datadir/.cookie

# *RECOMMENDED* - TCP bind - 'tcp' - DEFAULT: 0.0.0.0:50001, Specifies the IPv4
# or IPv6 interface:port to bind to.
tcp = 0.0.0.0:50001

# *RECOMMENDED* - SSL bind - 'ssl' - DEFAULT: Noting, Specifies the IPv4 or IPv6
# interface:port to bind to. The presence of this variable requires key= and
# cert= both be specified.
ssl = 0.0.0.0:50002

# *RECOMMENDED* - WS bind - 'ws' - DEFAULT: Nothing, Specifies the IPv4 or IPv6
# interface:port to bind to for Web Socket support (ws://).
ws = 0.0.0.0:50003

# *RECOMMENDED* - WSS bind - 'wss' - DEFAULT: Nothing, Specifies the IPv4 or
# IPv6 interface:port to bind to for Web Socket Secure support (wss://). The
# 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

# SSL private key - 'key' - DEFAULT: None (required for SSL) (PEM format)
key = /path/to/server-key.pem

# WSS-specific cert. - 'wss_cert' - DEFAULT: None
#wss_cert = /path/to/my-ca-signed-wss-fullchain.pem

# WSS-specific private key - 'wss_key' - DEFAULT: None
#wss_key = /path/to/my-ca-signed-wss-privkey.pem

# Public hostname - 'hostname' - It is highly recommended you set this correctly
# if you are interested in having your server peer with other servers --
# otherwise other servers may not peer with you if your hostname is missing or
# does not resolve to your public IP address.
hostname = fulcrum.bobs-bank.com

# Peer discovery - 'peering' - DEFAULT: true - If false, do not contact peers to
# discover other servers.
peering = true

# Peering: announce self - 'announce' - DEFAULT: true if hostname and peering
# are set, false otherwise. If true and the aforementioned conditions are met,
# then your server will announce itself to peers
announce = true

# Public TCP port - 'public_tcp_port' - DEFAULT: The first 'tcp' port configured
#public_tcp_port = 50001

# Public SSL port - 'public_ssl_port' - DEFAULT: The first 'ssl' port configured
#public_ssl_port = 50002

# Public WS port - 'public_ws_port' - DEFAULT: The first 'ws' port configured
#public_ws_port = 50003

# Public WSS port - 'public_wss_port' - DEFAULT: The first 'wss' port configured
#public_wss_port = 50004

# Admin RPC bind - 'admin' - DEFAULT: None -- *REQUIRED* to use "FulcrumAdmin"
admin = 8000  # <-- 1.2.3.4:8000 notation also accepted here

# Donation address - 'donation'
# - DEFAULT: bitcoincash:qplw0d304x9fshz420lkvys2jxup38m9symky6k028
donation = bitcoincash:qplw0d304x9fshz420lkvys2jxup38m9symky6k028

# Server banner text file - 'banner'
# - DEFAULT: Send a static string "Connected to a Fulcrum xx.x server"
#banner = /path/to/banner.txt

# HTTP stats bind - 'stats' - DEFAULT: None
stats = 8080  # <-- 1.2.3.4:8080 notation also accepted here

# Bitcoin daemon poll interval - 'polltime' - Default: 2.0 seconds
#polltime = 2.0

# Set this to a number in the 20-100 range if you want to limit memory
# consumption to conservative levels at the expense of performance. Default
# if unspecified is 20.
#db_max_open_files = 20

#-------------------------------------------------------------------------------
# TOR Configuration (optional)
#-------------------------------------------------------------------------------

# This is optional but if tor_hostname is set and if at least one tor_*_port is
# specified, we will also announce ourselves on Tor (if announce=true).
#tor_hostname=aykwhy6o2o4ixushlonpjooqv73fwx7jqgoreiknnqxuqv4dwffmb7qd.onion

# Tor banner is optional. If unset, will just user the regular banner=
#tor_banner=/path/to/another/alternate/banner_tor.txt

# Specify which port(s) are Tor. One of: tor_tcp_port, tor_ssl_port,
# tor_ws_port, or tor_wss_port (or any combination thereof) must be specified
# otherwise we won't announce ourselves via Tor.
#tor_tcp_port = 50001
#tor_ssl_port = 50002
#tor_ws_port = 50003
#tor_wss_port = 50004

# The proxy server to use to discover/connect-to Tor peers.
#tor_proxy = 9050   # e.g. localhost:9050. IP addr or hostname ok too: 10.0.0.1:9150, fooproxy.com:9050, etc.
#tor_user =  # leave this out unless you specified this in your torrc
#tor_pass =  # leave this out unless you specified this in your torrc