Server Settings

The following server settings are implemented in the libbitcoin-server and exposed in Bitcoin Server (BS).

[server]
# The lower limit of address and spend indexing, defaults to 0.
index_start_height = 0
# Disable public endpoints, defaults to false.
secure_only = false
# The number of query worker threads per endpoint, defaults to 1 (0 disables service).
query_workers = 1
# The maximum number of subscriptions, defaults to 0 (disabled).
subscription_limit = 0
# The subscription expiration time, defaults to 10.
subscription_expiration_minutes = 10
# The heartbeat interval, defaults to 5 (0 disables service).
heartbeat_interval_seconds = 5
# Enable the block publishing service, defaults to true.
block_service_enabled = true
# Enable the transaction publishing service, defaults to true.
transaction_service_enabled = true
# The public query endpoint, defaults to 'tcp://*:9091'.
public_query_endpoint = tcp://*:9091
# The public heartbeat endpoint, defaults to 'tcp://*:9092'.
public_heartbeat_endpoint = tcp://*:9092
# The public block publishing endpoint, defaults to 'tcp://*:9093'.
public_block_endpoint = tcp://*:9093
# The public transaction publishing endpoint, defaults to 'tcp://*:9094'.
public_transaction_endpoint = tcp://*:9094
# The secure query endpoint, defaults to 'tcp://*:9081'.
secure_query_endpoint = tcp://*:9081
# The secure heartbeat endpoint, defaults to 'tcp://*:9082'.
secure_heartbeat_endpoint = tcp://*:9082
# The secure block publishing endpoint, defaults to 'tcp://*:9083'.
secure_block_endpoint = tcp://*:9083
# The secure transaction publishing endpoint, defaults to 'tcp://*:9084'.
secure_transaction_endpoint = tcp://*:9084
# The Z85-encoded private key of the server, enables secure endpoints.
#server_private_key =
# Allowed Z85-encoded public key of the client, multiple entries allowed.
#client_public_key =
# Allowed client IP address, multiple entries allowed.
#client_address = 127.0.0.1

index_start_height

If this is set to 0 (default) all payment addresses in standard inputs and outputs, as well as all stealth metadata, is indexed. This is a large amount of information. To limit this indexing to more recent heights set this value to the desired starting height. This value can be safely changed at any time however the resulting index gaps will affect query results.

secure_only

Disable public endpoints, defaults to false.

query_workers

The number of query worker threads per endpoint, defaults to 1 (0 disables service).

subscription_limit

See the subscription interface.

subscription_expiration_minutes

After this amount of time has passed after registering a subscription the registration may be purged unless renewed. Clients may also explicitly unsubscribe.

heartbeat_interval_seconds

The heartbeat interval, defaults to 5 (0 disables service).

block_service_enabled

Enable the block publishing service, defaults to true.

transaction_service_enabled

Enable the transaction publishing service, defaults to true.

public_query_endpoint

Bind the public query socket to this endpoint.

public_heartbeat_endpoint

Bind the public heartbeat socket to this endpoint.

public_block_endpoint

Bind the public block publishing socket to this endpoint.

public_transaction_endpoint

Bind the public transaction publishing socket to this endpoint.

secure_query_endpoint

Bind the secure query socket to this endpoint.

secure_heartbeat_endpoint

Bind the secure heartbeat socket to this endpoint.

secure_block_endpoint

Bind the secure block publishing socket to this endpoint.

secure_transaction_endpoint

Bind the secure transaction publishing socket to this endpoint.

server_private_key

See secure server setup.

client_public_key

See restricted clients setup.

client_address

See filtered clients setup.