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

Commit

Permalink
Usage and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
florisvdg committed Mar 11, 2019
1 parent e5583f3 commit 8c239c5
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,41 @@ This moves the responsibility of securing your secrets to the domain of network
Download and extract the [latest release](https://github.com/keylockerbv/secrethub-proxy/releases/latest) of the SecretHub Proxy. Start it with your SecretHub credential:

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

### Docker

You can also run the proxy as a [Docker container](). Assuming you have a SecretHub credential stored in the default `$HOME/.secrethub` location, run:

```
docker run -p 8080:8080 --name secrethub -v /$HOME/.secrethub:/secrethub secrethubio/proxy
```

## Usage

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

### /v1/secrets/:path

Example:

```
/v1/secrets/my-org/my-repo/my-secret
```

#### GET

Returns the secret contents as bytes.

### POST

Creates or updates a secret. Expects the secret contents as bytes.

### DELETE

Deletes the entire secret and its history.

## Development

Get the source code:
Expand Down

0 comments on commit 8c239c5

Please sign in to comment.