Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added Docker and fixed smaller issues
  • Loading branch information
alexeyzimarev authored Oct 8, 2020
1 parent c742df7 commit 7f09019
Showing 1 changed file with 27 additions and 12 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Event Store Certificate Generation CLI

The command line interface to ease the generation of a certificate authority and node certificates for Event Store Db 20.6.x and above.
The command line interface to ease the generation of a certificate authority and node certificates for EventStoreDB 20.6.x and above.

## Getting Started

### Releases
The latest release for the ESGenCert CLI can be found under the [github releases page](https://github.com/EventStore/es-gencert-cli/releases).
We releases binaries for Windows/ Linux and MacOS.
The latest release for the es-gencert-cli can be found under the [GitHub releases page](https://github.com/EventStore/es-gencert-cli/releases).
We releases binaries for Windows, Linux and macOS. We also publish the tool as a Docker image.

### Usage

Expand All @@ -15,12 +15,14 @@ Basic usage for es-gencert-cli:
./es-gencert-cli [options] <command> [args]
```

Getting help for a specific command
```
Getting help for a specific command:

```bash
./es-gencert-cli -help <command>
```
e.g.
```

```bash
./es-gencert-cli -help create-ca

Usage: create_ca [options]
Expand All @@ -30,17 +32,30 @@ Options:
-out The output directory (default: ./ca)
```

### Examples
Generating a certificate authority
## Running with Docker

You could also run the tool using Docker interactive container:

```bash
docker run --rm -i eventstore/es-gencert-cli <command> <options>
```
.\es-gencert-cli create-ca -out .\es-ca

One useful scenarion is to use the tool inside the Docker Compose file to generate all the necessary certificates before starting cluster nodes. You can find an [example](https://github.com/EventStore/EventStore/blob/master/docker-compose.yml) in the EventStoreDB repository.

### Examples

Generating a certificate authority:

```bash
./es-gencert-cli create-ca -out ./es-ca
```

Generating a certificate for an Event Store Db node
Generating a certificate for an EventStoreDB node:

```
.\es-gencert-cli-cli.exe create-node -ca-certificate .\es-ca\ca.crt -ca-key .\es-ca\ca.key -out .\node1 -ip-addresses 127.0.0.1,172.20.240.1 -dns-names eventstore-node1.localhost.com
./es-gencert-cli-cli create-node -ca-certificate ./es-ca/ca.crt -ca-key ./es-ca/ca.key -out ./node1 -ip-addresses 127.0.0.1,172.20.240.1 -dns-names eventstore-node1.localhost.com
```

## Development

Building or working on `es-gencert-cli` requires a Go environment, version 1.14 or higher.
Building or working on `es-gencert-cli` requires a Go environment, version 1.14 or higher.

0 comments on commit 7f09019

Please sign in to comment.