btcpayserver-php-client/docs/configuration.md

Configuration

Configuration of this library can be done two different ways: using a PHP array or by using a YML file.

Config Options

All configuration options can be found in the class BTCPayServerConfigConfiguration:

public\_key

This is the full path and name for the public key. The default value is $HOME/.btcpayserver/btcpayserver.pub

private\_key

This is the full path and name for the private key. The default value is $HOME/.btcpayserver/btcpayserver.key

network

Specifies using the Live Bitcoin network or the Test Bitcoin network: livenet or testnet. The default is livenet.

adapter

Used mostly for testing. You shouldn't need to change or update this value.

key\_storage

The key_storage option allows you to specify a class for persisting and retrieving keys. By default this uses the BTCPayServer\Storage\EncryptedFilesystemStorage class.

key\_storage\_password

This is the password used to encrypt and decrypt keys on the filesystem.

Example YAML config

# /path/to/config.yml
btcpayserver:
    network: testnet

Corresponding PHP code:

$btcpay = new \BTCPayServer\BTCPayServer('/path/to/config.yml');

Example array config

$btcpay = new \BTCPayServer\BTCPayServer(
    array(
        'btcpay' => array(
            'network' => 'testnet',
        )
    )
);