From 91eab3552632d93a230fce68ee6b5cffb6241cf0 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Thu, 7 Mar 2024 16:16:21 -0800 Subject: [PATCH 1/2] Document `ord env` commands --- docs/src/guides/testing.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/src/guides/testing.md b/docs/src/guides/testing.md index a25e04204d..f1f1fa070c 100644 --- a/docs/src/guides/testing.md +++ b/docs/src/guides/testing.md @@ -13,7 +13,8 @@ then shuts down `bitcoind` and `ord server`. `9001` for `ord`'s RPC interface, but will fall back to random unused ports. Inside of the env directory, `ord env` will write `bitcoind`'s configuration to -`bitcoin.conf`, and the env configuration to `env.json`. +`bitcoin.conf`, `ord`'s configuration to `ord.yaml`, and the env configuration +to `env.json`. `env.json` contains the commands needed to invoke `bitcoin-cli` and `ord wallet`, as well as the ports `bitcoind` and `ord server` are listening on. @@ -28,6 +29,19 @@ ord=`jq -r '.ord_wallet_command | join(" ")' env/env.json` $ord outputs ``` +If `ord` is in the `$PATH` and the env directory is `env`, the `bitcoin-cli` +command will be: + +``` +bitcoin-cli -datadir=env` +``` + +And the `ord` will be: + +``` +ord --data-dir env +``` + Test Networks ------------- From 55ea68cc962f72456e3446aa757f191655503e17 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Thu, 7 Mar 2024 16:20:27 -0800 Subject: [PATCH 2/2] Modify --- docs/src/guides/settings.md | 7 +++++++ ord.yaml | 3 +++ 2 files changed, 10 insertions(+) diff --git a/docs/src/guides/settings.md b/docs/src/guides/settings.md index 453f28a8a4..ba6f893199 100644 --- a/docs/src/guides/settings.md +++ b/docs/src/guides/settings.md @@ -29,6 +29,13 @@ See `ord --help` for documentation of all the settings. `ord`'s current configuration can be viewed as JSON with the `ord settings` command. +Example Configuration +--------------------- + +```yaml +{{#include ../../../ord.yaml}} +``` + Hiding Inscription Content -------------------------- diff --git a/ord.yaml b/ord.yaml index d2f56e88c0..8a3dcceade 100644 --- a/ord.yaml +++ b/ord.yaml @@ -8,6 +8,8 @@ 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 first_inscription_height: 100 @@ -24,4 +26,5 @@ index_transactions: true integration_test: true no_index_inscriptions: true server_password: bar +server_url: http://localhost:8888 server_username: foo