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.

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

fix install docs #422

Merged
merged 2 commits into from
Apr 1, 2024
Merged
Changes from all commits
Commits
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
14 changes: 11 additions & 3 deletions docs/root/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,20 @@ Note that you should _never_ run with this quickstart configuration in productio
### To run confidant in Docker

It's necessary to export your configuration variables before running confidant.
You can either specify them as multiple -e options, or you can put them into an
You can either specify them as multiple -e options, or you can put them into
an environment file and use --env-file.

A production-ready docker image is available in
[GitHub Container Registry](https://github.com/lyft/confidant/pkgs/container/confidant).

```bash
docker pull ghcr.io/lyft/confidant:master
```

This image can then be ran with any of your desired command line flags:

```bash
docker pull lyft/confidant
docker run --env-file my_config -t lyft/confidant
docker run --rm ghcr.io/lyft/confidant:master --help
```

### To build the image
Expand Down
Loading