Skip to content

Commit 8a2a27b

Browse files
committed
Add sample data & docker info.
1 parent b8ec60c commit 8a2a27b

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ COPY deploy/docker-entrypoint.sh /usr/bin/
3030

3131
VOLUME ["/data"]
3232
VOLUME ["/conf"]
33+
VOLUME ["/jwtkeys"]
3334

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

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,30 @@ go get -u github.com/Vivino/rankdb/cmd/rankdb
4949

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

52-
5352
## Docker
5453

55-
// TODO
54+
A Dockerfile is included. You can download the docker image from docker hub:
55+
56+
```
57+
// TODO, something like:
58+
59+
docker pull vivino/rankdb
60+
docker run -e "GOGC=25" -p 8080:8080 -v /mnt/data:/data -v /mnt/conf:/conf vivino/rankdb
61+
```
62+
63+
By default the server will start on port 8080, which you can of course remap to a local port.
64+
65+
The following paths can/should be set:
66+
67+
* `/conf` should contain a `conf.toml` file with your configuration.
68+
* `/data` should point to where you want the local DB to be stored if you use one.
69+
* `/jwtkeys` can be used to add jwt keys. Set `JwtKeyPath = "/jwtkeys"` in your config.
70+
71+
## Sample Data
72+
73+
You can try out a test data set you can [download here](https://github.com/Vivino/rankdb/releases/tag/sample).
74+
75+
It will add some rather large tables to your database and you can test queries, etc. on that.
5676

5777
## Glossary
5878

0 commit comments

Comments
 (0)