TAPLE Client configuration
The configuration of a TAPLE-Cient node can be done in different ways. The supported mechanisms are listed below, from the highest to the lowest priority:
- Environment variables.
- Input parameters.
- File settings.toml.
- Default value.
General options
Database path
| Description | Path where the database is stored |
| EnvVar | TAPLE_DB_PATH |
| Input param | -d, --db-path |
| settings.toml | db-path |
| Admited values | Any valid writable folder path. Default to $HOME_PATH/.taple/db. if it does not exist or does not have write permissions, it uses tmp/.taple/db |
ID private key
| Description | Private key identifying the node's owner |
| EnvVar | TAPLE_ID_PRIVATE_KEY |
| Input param | -k, --id-private-key |
| settings.toml | id-private-key |
| Admited values | Private keys associated with an identity in TAPLE. HEX format |
ID key derivator
| Description | Key derivative to be used by the Taple node. |
| EnvVar | TAPLE_ID_KEY_DERIVATOR |
| Input param | --id-key-derivator |
| settings.toml | id-key-derivator |
| Admited values | ed25519 (default), secp256k1 |
Digest derivator
| Description | Digest derivator to use when signing. |
| EnvVar | TAPLE_DIGEST_DERIVATOR |
| Input param | --digest-derivator |
| settings.toml | digest-derivator |
| Admited values | Blake3_256 (default), Blake3_512, SHA2_256, SHA2_512, SHA3_256, SHA3_512 |
Key derivator
| Description | Key derivator to use when creating new key pairs. |
| EnvVar | TAPLE_KEY_DERIVATOR |
| Input param | --key-derivator |
| settings.toml | key-derivator |
| Admited values | ed25519 (default), secp256k1 |
Network
Listen address
| Description | Network interface on which incoming connections are listened for |
| EnvVar | TAPLE_NETWORK_LISTEN_ADDR |
| Input param | -a, --network.listen-addr |
| settings.toml | [network]
listen-addr |
| Admited values | A valid multiaddr representing a listen interface. More than 1 value can be specified. Default value: /ip4/0.0.0.0/tcp/40040 |
Known node
| Description | Address of a known node at start-up |
| EnvVar | TAPLE_NETWORK_KNOWN_NODE |
| Input param | --network.known-node |
| settings.toml | [network]
known-node |
| Admited values | A valid multiaddr. More than 1 value can be specified. |
External Address
| Description | Public address known at start-up |
| EnvVar | TAPLE_NETWORK_EXTERNAL_ADDR |
| Input param | --network.external-addr |
| settings.toml | [network]
external-addr |
| Admited values | A valid multiaddr. More than 1 value can be specified. |
API REST
Enable/disable
| Description | Enable/disable API REST |
| EnvVar | TAPLE_HTTP |
| Input param | --http |
| settings.toml | [http]
http |
| Admited values | Boolean value. Default: false |
Enable/disable documentation
| Description | Enable/disable API REST documentation. If enabled, documentation is available at /doc |
| EnvVar | TAPLE_HTTP_DOC |
| Input param | --http.doc |
| settings.toml | [http]
doc |
| Admited values | Boolean value. Default: false |
Port
| Description | API REST port |
| EnvVar | TAPLE_HTTP_PORT |
| Input param | --http.port |
| settings.toml | [http]
port |
| Admited values | A valid port number. Default: 3000 |
Address
| Description | Network interface on which incoming connections are listened for |
| EnvVar | TAPLE_HTTP_ADDR |
| Input param | --http.addr |
| settings.toml | [http]
addr |
| Admited values | A valid network interface. Default: 0.0.0.0 |
Smart contracts
Build path
| Description | Path where smart contracts are compiled |
| EnvVar | TAPLE_SC_BUILD_PATH |
| Input param | --sc.build-path |
| settings.toml | [sc]
build-path |
| Admited values | Any valid writable folder path. Default to $HOME_PATH/.taple/sc. if it does not exist or does not have write permissions, it uses tmp/.taple/sc |