Skip to content
This repository has been archived by the owner on Mar 8, 2023. It is now read-only.

Commit

Permalink
Passphrase arg docs
Browse files Browse the repository at this point in the history
  • Loading branch information
florisvdg committed Mar 19, 2019
1 parent 9488ef1 commit 6b45392
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,16 @@ Download and extract the [latest release](https://github.com/keylockerbv/secreth
./secrethub-proxy -C $(cat ~/.secrethub/credential) -p 8080
```

If upon signup you've chosen to lock your credential with a passphrase:

```
./secrethub-proxy -C $(cat ~/.secrethub/credential) -P mycredentialpassphrase -p 8080
```

### Docker

You can also run the proxy as a [Docker container](https://hub.docker.com/r/secrethubio/proxy). Assuming you have a SecretHub credential stored in the default `$HOME/.secrethub` location, you can run it with the credential mounted as volume:
You can also run the proxy as a [Docker container](https://hub.docker.com/r/secrethubio/proxy).
Assuming you have a SecretHub credential stored in the default `$HOME/.secrethub` location, you can run it with the credential mounted as volume:

```
docker run -p 8080:8080 --name secrethub -v $HOME/.secrethub:/secrethub secrethubio/proxy
Expand All @@ -29,6 +36,12 @@ You can also pass in the credential as an environment variable:
docker run -p 8080:8080 --name secrethub -e SECRETHUB_CREDENTIAL=$(cat $HOME/.secrethub/credential) secrethubio/proxy
```

If upon signup you've chosen to lock your credential with a passphrase:

```
docker run -p 8080:8080 --name secrethub -e SECRETHUB_CREDENTIAL=$(cat $HOME/.secrethub/credential) -e SECRETHUB_CREDENTIAL_PASSPHRASE=mycredentialpassphrase secrethubio/proxy
```

## Usage

With the proxy up and running, you can perform the following HTTP requests:
Expand Down

0 comments on commit 6b45392

Please sign in to comment.