設定
ord
はコマンドライン、環境変数、設定ファイル、デフォルト値で設定できます。
コマンドラインは環境変数より優先され、環境変数は設定ファイルより優先され、設定ファイルはデフォルト値より優先されます。
設定ファイルのパスは--config <CONFIG_PATH>
で指定できます。<CONFIG_PATH>
が存在しない場合、ord
はエラーを返します。
ord.yaml
という名前の設定ファイルを含むディレクトリのパスは、--config-dir <CONFIG_DIR_PATH>
または--datadir <DATA_DIR_PATH>
で指定できます。この場合、設定パスは<CONFIG_DIR_PATH>/ord.yaml
または<DATA_DIR_PATH>/ord.yaml
になります。ファイルが存在しなくてもエラーではありません。
--config
、--config-dir
、--datadir
のいずれも指定されておらず、デフォルトのデータディレクトリにord.yaml
という名前のファイルが存在する場合、それが読み込まれます。
コマンドラインで--setting-name
という名前の設定について、環境変数はORD_SETTING_NAME
という名前になり、設定ファイルのフィールドはsetting_name
という名前になります。例えば、データディレクトリはコマンドラインでは--datadir
、環境変数ではORD_DATA_DIR
、設定ファイルではdata_dir
で設定できます。
すべての設定のドキュメントについては、ord --help
を参照してください。
ord
の現在の設定は、ord settings
コマンドでJSONとして確認できます。
Example Configuration
# example config
# see `ord --help` for setting documentation
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
height_limit: 1000
hidden:
- 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_password: bar
server_url: http://localhost:8888
server_username: foo
Hiding Inscription Content
Inscription content can be selectively prevented from being served by ord server
.
Unlike other settings, this can only be configured with the configuration file or environment variables.
To hide inscriptions with an environment variable:
export ORD_HIDDEN='6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0 703e5f7c49d82aab99e605af306b9a30e991e57d42f982908a962a81ac439832i0'
Or with the configuration file:
hidden:
- 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0
- 703e5f7c49d82aab99e605af306b9a30e991e57d42f982908a962a81ac439832i0