Skip to content

Commit

Permalink
Document ord env commands (ordinals#3241)
Browse files Browse the repository at this point in the history
  • Loading branch information
casey committed Mar 8, 2024
1 parent 4747a28 commit bf0da3b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/src/guides/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------

Expand Down
16 changes: 15 additions & 1 deletion docs/src/guides/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
-------------

Expand Down
3 changes: 3 additions & 0 deletions ord.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -24,4 +26,5 @@ index_transactions: true
integration_test: true
no_index_inscriptions: true
server_password: bar
server_url: http:https://localhost:8888
server_username: foo

0 comments on commit bf0da3b

Please sign in to comment.