Skip to content

Commit

Permalink
docs: slightly easier README
Browse files Browse the repository at this point in the history
commit-id:6e1d2694
  • Loading branch information
martinohansen committed Sep 20, 2024
1 parent 7801928 commit 77c792a
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,21 @@ NORDIGEN_SECRET_KEY=<nordigen secret key>
EOT
```

All valid config options can be found in the [config.go](config.go) file.
_All valid config options can be found [here](https://pkg.go.dev/github.com/martinohansen/ynabber#Config)_

To read the environment variables from a file and run the binary one can use the
[declare](https://www.gnu.org/software/bash/manual/bash.html#index-declare)
command:
Once the environment variables are set, run the binary:

```bash
# Read environment variables from file and run ynabber
declare $(cat ynabber.env); ynabber
# Read environment variables from file first
set -a; . ./ynabber.env; set +a; ynabber
ynabber
```

Or run the container and parse in the variables with
[Docker](https://docs.docker.com/engine/reference/run/)
Or run in a container with
[Docker](https://docs.docker.com/engine/reference/run/):

```bash
docker run --env-file=ynabber.env ghcr.io/martinohansen/ynabber:latest

# To keep data persistent
```bash
docker run \
--volume ${PWD}:/data \
--env 'YNABBER_DATADIR=/data' \
Expand Down

0 comments on commit 77c792a

Please sign in to comment.