Skip to content

Commit 8ad5e49

Browse files
committed
feat(configuration.md): add BTC config docs
1 parent b4717c6 commit 8ad5e49

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/getting-started/configuration.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ coin:
2929
url: ${XMR_DAEMON_URL}
3030
user: ${XMR_DAEMON_USER}
3131
pass: ${XMR_DAEMON_PASS}
32+
btc:
33+
daemon:
34+
url: ${BTC_DAEMON_URL}
35+
user: ${BTC_DAEMON_USER}
36+
pass: ${BTC_DAEMON_PASS}
3237
```
3338
3439
<details>
@@ -179,6 +184,39 @@ coin:
179184
</details>
180185
</details>
181186
</details>
187+
<details>
188+
<summary>btc</summary>
189+
<details>
190+
<summary>daemon</summary>
191+
<details>
192+
<summary>url</summary>
193+
<div>
194+
<p><strong>Description:</strong> The URL of the Bitcoin (BTC) daemon endpoint.</p>
195+
<p><strong>CLI Option:</strong> <code>none</code></p>
196+
<p><strong>Environment Variable:</strong> <code>BTC_DAEMON_URL</code></p>
197+
<p><strong>Default Value:</strong> <code>none</code></p>
198+
</div>
199+
</details>
200+
<details>
201+
<summary>user</summary>
202+
<div>
203+
<p><strong>Description:</strong> The username for authenticating with the BTC daemon.</p>
204+
<p><strong>CLI Option:</strong> <code>none</code></p>
205+
<p><strong>Environment Variable:</strong> <code>BTC_DAEMON_USER</code></p>
206+
<p><strong>Default Value:</strong> <code>none</code></p>
207+
</div>
208+
</details>
209+
<details>
210+
<summary>pass</summary>
211+
<div>
212+
<p><strong>Description:</strong> The password for authenticating with the BTC daemon.</p>
213+
<p><strong>CLI Option:</strong> <code>none</code></p>
214+
<p><strong>Environment Variable:</strong> <code>BTC_DAEMON_PASS</code></p>
215+
<p><strong>Default Value:</strong> <code>none</code></p>
216+
</div>
217+
</details>
218+
</details>
219+
</details>
182220
</details>
183221
184222
## Example env file
@@ -203,6 +241,10 @@ DATABASE_NAME=goipay_db
203241
XMR_DAEMON_URL=http://node.monerodevs.org:38089
204242
XMR_DAEMON_USER=
205243
XMR_DAEMON_PASS=
244+
245+
BTC_DAEMON_URL=http://localhost:38332
246+
BTC_DAEMON_USER=user
247+
BTC_DAEMON_PASS=pass
206248
```
207249

208250
## Misc CLI options

0 commit comments

Comments
 (0)