Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
add docker instructions
  • Loading branch information
acavella committed Jan 7, 2024
1 parent 02a5ae8 commit 0af0713
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,40 @@ Automates the download and hosting of CRL data from remote Certificate Authoriti

## Installation

```Installation instructions here.
GoRevoke is designed to be deployed and run as a container. Additional instructions are provided if you'd like to deploy from source on baremetal.

### Docker Instructions

1. Create a application configuration directory and file; this example maps a volume to the `/appdata` directory.
```Yaml=
---
default:
gateway: crls.pki.goog # ip or fqdn to check used for connectivity checks
interval: 900 # update interval to check for new crls, in seconds
port: 4000 # port used by http server
ca:
id:
- x21
- x11
uri:
- http://crls.pki.goog/gts1c3/zdATt0Ex_Fk.crl
- http://crl.godaddy.com/gdig2s1-5609.crl
```

```Shell
docker run -d \
--name gorevoke \
-p 80:4000 \
-v /appdata/gorevoke/config:/usr/local/bin/gorevoke/conf \
--restart=unless-stopped \
s0lution/gorevoke:1.0.0-rc.8
```

### Baremetal Instructions

```Text
Installation instructions here.
```

## Container Performance
Expand Down

0 comments on commit 0af0713

Please sign in to comment.