scuffed-kv is a low performance and non-distributed key-value store accessible through an HTTP API, that is built around a modular configuration to enable features on the fly.
The easiest way to get this up and running is to simply use docker in combination with docker-compose.
Once you have cloned the directory, cd into it and simply run:
docker-compose up -d
Now go onto http://localhost:80/docs and you should see the all reference documentation.
You can storage persistent by simply amending a path to /scuffed-kv/db.
version: "3.9"
services:
scuffedkv:
build: .
volumes:
- ./db:/scuffed-kv/db
ports:
- 80
scuffed-kv can be used with Traefik simply:
version: "3.9"
services:
scuffedkv:
build: .
volumes:
- ./db:/scuffed-kv/db
ports:
- 80
networks:
- proxy
labels:
- "traefik.enable=true"
- "traefik.http.routers.scuffedkv.rule=Host(`scuffedkv.domain.com`)"
- "traefik.http.routers.scuffedkv.tls=true"
- "treafik.port=80"
- "traefik.http.routers.scuffedkv.entrypoints=websecure"
- "traefik.http.routers.scuffedkv.tls.certresolver=letsencrypt"
- "traefik.http.middlewares.scuffedkv.headers.SSLRedirect=true"
- "traefik.http.middlewares.scuffedkv.headers.browserXSSFilter=true"
- "traefik.http.middlewares.scuffedkv.headers.STSPreload=true"
restart: unless-stopped
networks:
proxy:
driver: bridge
name: proxy
You can read all documentation by amending /docs to the scuffed-kv URL.