Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kayra1 committed Aug 13, 2024
1 parent 62a3e59 commit bf7b20c
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@

GoCert is a certificate management tool.

## Installation

```bash
docker pull ghcr.io/canonical/gocert:latest
docker run -it ghcr.io/canonical/gocert:latest
```

## Requirements

GoCert requires 3 files to operate:
Expand Down Expand Up @@ -36,9 +29,31 @@ The config file requires the following parameters:
An example config file may look like:

```yaml
key_path: "./key.pem"
cert_path: "./cert.pem"
db_path: "./certs.db"
key_path: "/gocert/key.pem"
cert_path: "/gocert/cert.pem"
db_path: "/gocert/certs.db"
port: 3000
pebble_notifications: true
```
```
## Installation
### From OCI Image
You can run GoCert in docker by doing:
```bash
docker pull ghcr.io/canonical/gocert:latest
docker run -it ghcr.io/canonical/gocert:latest
```

You will then need to push the 3 required files before it will launch successfully. You can do this by
```bash
docker exec gocert /usr/bin/pebble mkdir /etc/config
docker cp key.pem gocert:/etc/config/key.pem
docker cp cert.pem gocert:/etc/config/cert.pem
docker cp config.yaml gocert:/etc/config/config.yaml
docker restart gocert
```

### Build from Source

0 comments on commit bf7b20c

Please sign in to comment.