Skip to content

Commit

Permalink
edit installation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zorino committed Feb 5, 2020
1 parent d8c3e5c commit 3bd4b99
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,25 @@ To run kaamer you will need at least GO >= 1.13 (https://golang.org/doc/install)

This command will download and install kaamer executables (kaamer and kaamer-db) into your `GOPATH`

#### Install from source

```shell
export GO111MODULE=on
git clone https://github.com/zorino/kaamer.git
cd kaamer
go install ./...
```

#### Using Docker

You will need a database to mount onto the container (/kaamer-db)

```shell
docker run --name kaamer-db -d -p 8321:8321 -v /kaamer-db:/data zorino/kaamer
```

#### Using Binaries

You can also download precompiled binaries : https://github.com/zorino/kaamer/releases
> However to deploy the Web UI and Web documentation you need to compile from source.
Expand Down

0 comments on commit 3bd4b99

Please sign in to comment.