From 91d33b513ae243cba066b0c47f95c7dbf84f0dbe Mon Sep 17 00:00:00 2001 From: Dennis Reimann Date: Thu, 30 Sep 2021 11:12:48 +0200 Subject: [PATCH 1/4] Fix firefly link --- docs/fireflyiii.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fireflyiii.md b/docs/fireflyiii.md index f05efcd..9ece321 100644 --- a/docs/fireflyiii.md +++ b/docs/fireflyiii.md @@ -1,6 +1,6 @@ # Firefly III support -[Firefly III](https://pi-hole.net/) is a self-hosted financial manager. +[Firefly III](https://www.firefly-iii.org/) is a self-hosted financial manager. It can help you keep track of expenses, income, budgets and everything in between. It supports credit cards, shared household accounts and savings accounts. It’s pretty fancy. You should use it to save and organise money. ## How to use From 54bd6eedef96497608f8d1dea9ea2d2b4b98c738 Mon Sep 17 00:00:00 2001 From: Dennis Reimann Date: Thu, 30 Sep 2021 11:13:12 +0200 Subject: [PATCH 2/4] Fix instructions link for docs --- docs/joinmarket.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/joinmarket.md b/docs/joinmarket.md index 05ecb14..c18bb4e 100644 --- a/docs/joinmarket.md +++ b/docs/joinmarket.md @@ -32,7 +32,7 @@ jm.sh wallet-tool ## How to fine tune? -In the [README](../README.md), follow the instruction in `How can I customize the generated docker-compose file?`. +Follow the [How can I customize the generated docker-compose file?](https://github.com/btcpayserver/btcpayserver-docker/blob/master/README.md#how-can-i-customize-the-generated-docker-compose-file) instructions. Then pass as environment variable the attribute you want to modify, prefixed by `jm_`. Our system is using the default configuration of joinmarket, then replace the values your specify like this. From 81a17317e1aa0420dd12c5bc63ab6fd9fdb9a583 Mon Sep 17 00:00:00 2001 From: Dennis Reimann Date: Thu, 30 Sep 2021 11:13:38 +0200 Subject: [PATCH 3/4] Fix video link and preview image for docs --- docs/ndlc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ndlc.md b/docs/ndlc.md index a6128c7..a2b97bd 100644 --- a/docs/ndlc.md +++ b/docs/ndlc.md @@ -25,7 +25,7 @@ The `Contract Execution Transaction` (or `CET`) is the transaction distributing The following documentation is also explained in this video. -[](https://youtu.be/DakwshnNkho) +[![How to make a DLC with NDLC-CLI](https://img.youtube.com/vi/DakwshnNkho/mqdefault.jpg)](https://www.youtube.com/watch?v=DakwshnNkho) ## How to use From 3c98599e6090477ca8af0b3d44edfe4c2613136b Mon Sep 17 00:00:00 2001 From: Dennis Reimann Date: Thu, 30 Sep 2021 11:14:08 +0200 Subject: [PATCH 4/4] Markdown formatting --- docs/fireflyiii.md | 1 + docs/joinmarket.md | 5 +++-- docs/ndlc.md | 3 ++- docs/pihole.md | 2 ++ 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/fireflyiii.md b/docs/fireflyiii.md index 9ece321..f1e8f4b 100644 --- a/docs/fireflyiii.md +++ b/docs/fireflyiii.md @@ -15,4 +15,5 @@ FIREFLY_HOST="firefly.yourserver.org" . btcpay-setup.sh -i . ./Tools/fireflyiii/init.sh ``` + 4. Access Firefly III at `firefly.yourserver.org` and create your admin account. diff --git a/docs/joinmarket.md b/docs/joinmarket.md index c18bb4e..8b036cc 100644 --- a/docs/joinmarket.md +++ b/docs/joinmarket.md @@ -53,6 +53,7 @@ services: By running `jm.sh` without parameter, you will get a bunch of command that you can run such as: For example: + ``` Usage: ------ @@ -84,6 +85,7 @@ Example: ``` Note `jm.sh` commands are wrapper around joinmarket scripts. Those wrapper makes your life easier by: + 1. Avoiding, when it can, that you enter wallet file name/ wallet password 2. Stop and Start the yield generator for the duration of the operation @@ -108,10 +110,9 @@ This is because the yield generator is running. You can stop and start the yield generator with the helper scripts in the container `stop.sh` and `start.sh`. - ## Troubleshooting Run `jm.sh logs` to get the logs of the yield generator. A common issue is that a lock file is present, preventing it to restart. -In which case, connect directly into the container with `jm.sh bash` and delete the problematic file. \ No newline at end of file +In which case, connect directly into the container with `jm.sh bash` and delete the problematic file. diff --git a/docs/ndlc.md b/docs/ndlc.md index a2b97bd..bc96110 100644 --- a/docs/ndlc.md +++ b/docs/ndlc.md @@ -16,6 +16,7 @@ The `oracle` roles is to define the `event` and `attest` a single outcome of the Let's call Alice and Bob the two parties of the contract, and Olivia the oracle. A DLC will show two transactions on the chain: + * The Funding Transaction * The Contract Execution Transaction (CET) @@ -42,4 +43,4 @@ You can then use `ndlc-cli.sh` to run use ndlc-cli, for example: ndlc.sh oracle generate MyOwnOracle ``` -Read our documentation on our [github repository](https://github.com/dgarage/NDLC/blob/master/docs/Concepts.md). \ No newline at end of file +Read our documentation on our [GitHub repository](https://github.com/dgarage/NDLC/blob/master/docs/Concepts.md). diff --git a/docs/pihole.md b/docs/pihole.md index bc2c876..2a500c0 100644 --- a/docs/pihole.md +++ b/docs/pihole.md @@ -42,12 +42,14 @@ docker logs pihole | grep random ``` If the password does not work, you can try to reset the password: + ```bash pihole.sh -a -p docker restart pihole ``` Then running again + ```bash docker logs pihole | grep random ```