Instellingen

ord kan worden geconfigureerd met de opdrachtregel, omgevingsvariabelen, een configuratiebestand en standaardwaarden.

De opdrachtregel heeft voorrang boven omgevingsvariabelen, die weer voorrang hebben boven het configuratiebestand, dat voorrang heeft boven de standaardwaarden.

Het pad naar het configuratiebestand kan worden opgegeven met --config <CONFIG_PATH>. ord zal een foutmelding geven als <CONFIG_PATH> niet bestaat.

Het pad naar een map met een configuratiebestand genaamd ord.yaml kan worden opgegeven met --config-dir <CONFIG_DIR_PATH> of --datadir <DATA_DIR_PATH>, waarbij het configuratiepad <CONFIG_DIR_PATH>/ord.yaml of <DATA_DIR_PATH>/ord.yaml is. Het is geen fout als het bestand niet bestaat.

Als geen van --config, --config-dir of --datadir is opgegeven, en er bestaat een bestand genaamd ord.yaml in de standaardgegevensmap, zal dit bestand worden geladen.

Voor een instelling genaamd --setting-name op de opdrachtregel, zal de omgevingsvariabele ORD_SETTING_NAME heten en het configuratiebestandveld setting_name. Bijvoorbeeld, de gegevensmap kan worden geconfigureerd met --datadir op de opdrachtregel, de omgevingsvariabele ORD_DATA_DIR, of data_dir in het configuratiebestand.

Zie ord --help voor documentatie van alle instellingen.

De huidige configuratie van ord kan als JSON worden bekeken met het commando ord settings.

Voorbeeldconfiguratie

# voorbeeld config

# zie `ord --help` voor documentatie over instellingen

bitcoin_data_dir: /var/lib/bitcoin
bitcoin_rpc_password: bar
bitcoin_rpc_url: https://localhost:8000
bitcoin_rpc_username: foo
chain: mainnet
commit_interval: 10000
config: /var/lib/ord/ord.yaml
config_dir: /var/lib/ord
cookie_file: /var/lib/bitcoin/.cookie
data_dir: /var/lib/ord
hoogte_limiet: 1000
verborgen:
- 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0
- 703e5f7c49d82aab99e605af306b9a30e991e57d42f982908a962a81ac439832i0
index: /var/lib/ord/index.redb
index_addresses: true
index_cache_size: 1000000000
index_runes: true
index_sats: true
index_transactions: true
integration_test: true
no_index_inscriptions: true
server_wachtwoord: bar
server_url: http://localhost:8888
server_username: foo

Inscriptie-inhoud verbergen

Inscriptie-inhoud kan selectief worden verhinderd om te worden aangeboden door ord server.

In tegenstelling tot andere instellingen, kan dit alleen worden geconfigureerd met het configuratiebestand of omgevingsvariabelen.

Om inscripties te verbergen met een omgevingsvariabele:

export ORD_HIDDEN='6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0 703e5f7c49d82aab99e605af306b9a30e991e57d42f982908a962a81ac439832i0'

Of met het configuratiebestand:

verborgen:
- 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0
- 703e5f7c49d82aab99e605af306b9a30e991e57d42f982908a962a81ac439832i0