Skip to content

Commit

Permalink
Add example docker-compose file to README for easy access on docker hub.
Browse files Browse the repository at this point in the history
  • Loading branch information
felddy committed Aug 16, 2019
1 parent 04c20d2 commit 1d90c2d
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ all wrapped up in a tasty [Docker](https://www.docker.com) container.
## Usage ##

Consider using a `docker-compose.yml` file to run Certboto.
You can find an example in this project's repository.
See the Install section below.

To issue a new certificate:

Expand All @@ -39,10 +39,35 @@ docker-compose run certboto --help

### Install ###

Create a `docker-compose.yml` file similar to this:

```yml
---
version: "3.7"

secrets:
credentials:
file: /home/username/.aws/credentials

services:
certboto:
image: dhsncats/certboto
init: true
restart: "no"
environment:
- AWS_DEFAULT_REGION=us-east-1
- BUCKET_NAME=my-certificates
- BUCKET_PROFILE=certsync-role
- DNS_PROFILE=dns-role
secrets:
- source: credentials
target: credentials
```
Pull `dhsncats/certboto` from the Docker repository:

```console
docker pull dhsncats/certboto
docker-compose pull
```

Or build `dhsncats/certboto` from source:
Expand Down

0 comments on commit 1d90c2d

Please sign in to comment.