Skip to content

Commit ee789bc

Browse files
committed
Add instructions for setting ION config
1 parent 5c9d888 commit ee789bc

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

docs/ion.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -344,44 +344,45 @@ Having defined `ION_CONFIG` environment variable (above), use it to create the f
344344
$ mkdir $ION_CONFIG
345345
```
346346

347-
Next, copy the template ION configuration files to your `ION_CONFIG` directory:
348-
349347
=== "Mainnet"
350348

349+
Next, copy the template ION configuration files to your `ION_CONFIG` directory:
351350
```console
352351
$ cp $ION_REPO/config/mainnet-bitcoin-config.json $ION_REPO/config/mainnet-bitcoin-versioning.json $ION_REPO/config/mainnet-core-config.json $ION_REPO/config/mainnet-core-versioning.json $ION_CONFIG
353352
```
354353

355-
=== "Testnet"
354+
The following commands will edit some of the configuration parameters inside the file named `mainnet-bitcoin-config.json`.
356355

356+
Set the `bitcoinDataDirectory` parameter (skip this step if your `BITCOIN_DATA` directory is on a network drive):
357357
```console
358-
$ cp $ION_REPO/config/testnet-bitcoin-config.json $ION_REPO/config/testnet-bitcoin-versioning.json $ION_REPO/config/testnet-core-config.json $ION_REPO/config/testnet-core-versioning.json $ION_CONFIG
358+
$ sed -i '' 's|"bitcoinDataDirectory": ".*"|"bitcoinDataDirectory": "'$BITCOIN_DATA'"|g' $ION_CONFIG/mainnet-bitcoin-config.json
359359
```
360360

361-
Now you will need to edit some of these configuration files to add the parameters specific to your system. These instructions use the `pico` text editor, but you can use whichever editor you like.
361+
Set the `bitcoinRpcUsername` parameter: TODO.
362362

363-
=== "Mainnet"
363+
Set the `bitcoinRpcPassword` parameter: TODO.
364364

365-
Open the file `mainnet-bitcoin-config.json` in the `pico` text editor:
366-
```console
367-
$ pico $ION_CONFIG/mainnet-bitcoin-config.json
368-
```
369-
TODO.
365+
Set the `bitcoinWalletImportString` parameter TODO. Note: this can be left unchanged for now *only* on testnet. On mainnet it must be a mainnet-compatible WIF.
370366

371367
=== "Testnet"
372368

373-
OLD:
374-
Open the file `testnet-bitcoin-config.json` in the `pico` text editor:
369+
Next, copy the template ION configuration files to your `ION_CONFIG` directory:
375370
```console
376-
$ pico $ION_CONFIG/testnet-bitcoin-config.json
371+
$ cp $ION_REPO/config/testnet-bitcoin-config.json $ION_REPO/config/testnet-bitcoin-versioning.json $ION_REPO/config/testnet-core-config.json $ION_REPO/config/testnet-core-versioning.json $ION_CONFIG
377372
```
378373

379-
NEW:
380-
Update the config parameters for the ION Bitcoin microservice in the config file `testnet-bitcoin-config.json`:
374+
The following commands will edit some of the configuration parameters inside the file named `testnet-bitcoin-config.json`.
375+
376+
Set the `bitcoinDataDirectory` parameter (skip this step if your `BITCOIN_DATA` directory is on a network drive):
381377
```console
382-
sed -i '' 's|"bitcoinDataDirectory": "[FILL THIS IN!]"|"bitcoinDataDirectory": "$BITCOIN_DATA"|g' $ION_CONFIG/testnet-bitcoin-config.json
378+
$ sed -i '' 's|"bitcoinDataDirectory": ".*"|"bitcoinDataDirectory": "'$BITCOIN_DATA'testnet3/"|g' $ION_CONFIG/testnet-bitcoin-config.json
383379
```
384380

381+
Set the `bitcoinRpcUsername` parameter: TODO.
382+
383+
Set the `bitcoinRpcPassword` parameter: TODO.
384+
385+
385386
... TODO FROM HERE ...
386387

387388
- `bitcoinDataDirectory`

0 commit comments

Comments
 (0)