Skip to content

Commit

Permalink
Add sample data & docker info.
Browse files Browse the repository at this point in the history
  • Loading branch information
klauspost committed Jul 31, 2019
1 parent b8ec60c commit 8a2a27b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ COPY deploy/docker-entrypoint.sh /usr/bin/

VOLUME ["/data"]
VOLUME ["/conf"]
VOLUME ["/jwtkeys"]

HEALTHCHECK --interval=1m CMD rankdb-cli --timeout=1s health health

Expand Down
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,30 @@ go get -u github.com/Vivino/rankdb/cmd/rankdb

You can now open the documentation/sample UI on http://127.0.0.1:8080


## Docker

// TODO
A Dockerfile is included. You can download the docker image from docker hub:

```
// TODO, something like:
docker pull vivino/rankdb
docker run -e "GOGC=25" -p 8080:8080 -v /mnt/data:/data -v /mnt/conf:/conf vivino/rankdb
```

By default the server will start on port 8080, which you can of course remap to a local port.

The following paths can/should be set:

* `/conf` should contain a `conf.toml` file with your configuration.
* `/data` should point to where you want the local DB to be stored if you use one.
* `/jwtkeys` can be used to add jwt keys. Set `JwtKeyPath = "/jwtkeys"` in your config.

## Sample Data

You can try out a test data set you can [download here](https://github.com/Vivino/rankdb/releases/tag/sample).

It will add some rather large tables to your database and you can test queries, etc. on that.

## Glossary

Expand Down

0 comments on commit 8a2a27b

Please sign in to comment.