Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: slightly easier README #94

Merged
merged 1 commit into from
Sep 20, 2024
Merged

docs: slightly easier README #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions README.md
View file
Open in desktop
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
Loading