Skip to content

Commit

Permalink
add install instructions to README.md
Browse files Browse the repository at this point in the history
This commit adds how to install KES instructions
to the README.md. This is in particularly necessary
since we now support signed releases and the public key
for verification must be presented to users in way that
ensures that it is not modified by an attacker.

With this change the public key is show as part of the README.md
which is part of the git repository. So only people with push/commit
access can change it and if they do the change will be preserved
in the git history (or they have to rewrite the history which most
probably will be detected).

Further, this commit adds docker install instructions.
  • Loading branch information
Andreas Auernhammer committed Mar 14, 2020
1 parent 462c981 commit f8cbc38
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,37 @@
# Kes
Kes is a tool for managing and distributing secret keys at scale. In particular, it decouples a traditional key-management-system (KMS) - like AWS-KMS or Hashicorp Vault from large-scale and high-performance applications.

## Install

### Binary Releases

| OS | ARCH | Binary |
|:-------:|:-----:|:-----------------:|
| Linux | amd64 | [linux-amd64](https://github.com/minio/kes/releases/latest/download/linux-amd64.zip)
| Linux | arm | [linux-arm](https://github.com/minio/kes/releases/latest/download/linux-arm.zip)
| Apple | amd64 | [darwin-amd64](https://github.com/minio/kes/releases/latest/download/darwin-amd64.zip)
| Windows | amd64 | [windows-amd64](https://github.com/minio/kes/releases/latest/download/windows-amd64.zip)

You can also verify the binary with [minisign](https://jedisct1.github.io/minisign/) by downloading the corresponding [`.minisign`](https://github.com/minio/kes/releases/latest) signature file. Then run:
```
minisign -Vm <OS-ARCH>.zip -P RWRcOzQ19UrKLp4rkfssIwwWiWagluGJ8fpUBh/BeH+bZV3keFcdIJTF
```

### Docker

Pull the latest release via:
```
docker pull minio/kes
```

### Build from source

```
GO111MODULE=on go get github.com/minio/kes/cmd/kes
```
> You will need a working Go environment. Therefore, please follow [How to install Go](https://golang.org/doc/install).
> Minimum version required is go1.13
## Getting Started
For your first steps checkout our [Getting Started](https://github.com/minio/kes/wiki/Getting-Started) guide.

Expand Down

0 comments on commit f8cbc38

Please sign in to comment.