1
0

Merge pull request #537 from dennisreimann/docs

Docs improvements
This commit is contained in:
Pavlenex
2021-09-30 11:29:47 +02:00
committed by GitHub
4 changed files with 11 additions and 6 deletions

View File

@@ -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. Its pretty fancy. You should use it to save and organise money.
## How to use
@@ -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.

View File

@@ -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.
@@ -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.
In which case, connect directly into the container with `jm.sh bash` and delete the problematic file.

View File

@@ -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)
@@ -25,7 +26,7 @@ The `Contract Execution Transaction` (or `CET`) is the transaction distributing
The following documentation is also explained in this video.
[<img src="https://img.youtube.com/vi/DakwshnNkho/mqdefault.jpg">](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
@@ -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).
Read our documentation on our [GitHub repository](https://github.com/dgarage/NDLC/blob/master/docs/Concepts.md).

View File

@@ -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
```