Update README with accurate info on how to build Bottin

This commit is contained in:
Alex 2020-02-02 12:34:52 +01:00
parent 8de94a32a8
commit e9e7a4cb4b
3 changed files with 14 additions and 4 deletions

View file

@ -15,7 +15,6 @@ Features:
- Access control through an ACL (hardcoded in the configuration file) - Access control through an ACL (hardcoded in the configuration file)
Building Bottin can be done simply by running `go build` in this folder.
A Docker image is provided on the [Docker hub](https://hub.docker.com/r/lxpz/bottin_amd64). A Docker image is provided on the [Docker hub](https://hub.docker.com/r/lxpz/bottin_amd64).
An example for running Bottin on a Nomad cluster can be found in `bottin.hcl.example`. An example for running Bottin on a Nomad cluster can be found in `bottin.hcl.example`.
@ -26,6 +25,14 @@ The configuration file is a JSON file whose contents is described in the followi
Bottin is licensed under the terms of the GPLv3. Bottin is licensed under the terms of the GPLv3.
## Building Bottin
Bottin requires go 1.13 or later.
To build Bottin, clone this repository outside of your `$GOPATH`.
Then, run `make` in the root of the repo.
## Server initialization ## Server initialization
When Bottin is launched on an empty database, When Bottin is launched on an empty database,

6
TODO.md Normal file
View file

@ -0,0 +1,6 @@
- Switch to `go mod` for building Bottin
- Implement missing search filters (in applyFilter)
- Add an initial prefix to the consul key value
- Potential bugs with different combinations of lower/uppercase names

View file

@ -1,8 +1,5 @@
package main package main
// @FIXME: Proper handling of various upper/lower case combinations
// @FIXME: Implement missing search filters (in applyFilter)
// @FIXME: Add an initial prefix to the consul key value
import ( import (
"crypto/rand" "crypto/rand"