Skip to content

Commit cb08d6b

Browse files
committed
merged #12
2 parents fa84b7a + 7413d1f commit cb08d6b

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ jobs:
146146
-u scalableminds
147147
-r fossildb
148148
-c $(git rev-parse HEAD)
149-
-b "executable jar of __fossildb__"
149+
-b "executable jar of __FossilDB__"
150150
$(cat /tmp/workspace/version)
151151
/tmp/workspace/fossildb.jar
152152

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,25 @@
33
Versioned Key-Value Store with RocksDB backend and gRPC API
44

55
[![CircleCI](https://circleci.com/gh/scalableminds/fossildb.svg?style=svg&circle-token=89b8341a216f2ce9e8f40c913b45196b3694347a)](https://circleci.com/gh/scalableminds/fossildb)
6+
7+
## Installation & Usage
8+
You can download the [executable jar](https://github.com/scalableminds/fossildb/releases/latest),
9+
```
10+
java -jar fossildb.jar -c default
11+
```
12+
or use a [docker image](https://hub.docker.com/r/scalableminds/fossildb/tags) and run
13+
```
14+
docker run scalableminds/fossildb:master fossildb -c default
15+
```
16+
17+
For further options, see `help`:
18+
```
19+
-p, --port <num> port to listen on. Default: 7155
20+
-d, --dataDir <path> database directory. Default: data
21+
-b, --backupDir <path> backup directory. Default: backup
22+
-c, --columnFamilies <cf1>,<cf2>...
23+
column families of the database (created if there is no db yet)
24+
```
25+
26+
## API
27+
FossilDB can be used via its [gRPC API](src/main/protobuf/fossildbapi.proto).

fossildb

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ set -Eeuo pipefail
44
FOSSILDB_HOME=$(dirname $(readlink -f $0))
55

66
if [ "$(id -u)" = '0' ]; then
7-
chown -R fossildb $FOSSILDB_HOME/data $FOSSILDB_HOME/backup
7+
for SUBDIR in data backup; do
8+
DIR=$FOSSILDB_HOME/$SUBDIR
9+
if [ -d "$DIR" ]; then
10+
chown -R fossildb $DIR
11+
fi
12+
done
813
exec gosu fossildb java -jar $FOSSILDB_HOME/fossildb.jar $@
914
else
1015
exec java -jar $FOSSILDB_HOME/fossildb.jar $@

0 commit comments

Comments
 (0)