Skip to content

Commit ba211b1

Browse files
committed
update docs and docker
1 parent b7f929a commit ba211b1

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

Dockerfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ FROM scratch
22
# 8080 for API
33
EXPOSE 8080/tcp
44
VOLUME /data
5-
ENV API_NOTES_BIND=":8080" \
6-
API_NOTES_PUBLIC_URL="http://127.0.0.1:8081" \
7-
API_NOTES_DIR="/data"
8-
ENTRYPOINT ["/api-notes"]
9-
ADD api-notes /
5+
ENV API_KV_BIND=":8080" \
6+
API_KV_DIR="/data" \
7+
API_KV_TOKEN="changeme"
8+
ENTRYPOINT ["/api-kv"]
9+
ADD api-kv /

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API-KV: Simple and Flexible Key-Value Storage API
22

3-
![apikv-logo.png](_docs%2Fapikv-logo.png)
3+
![apikv-logo.png](_docs/apikv-logo.png)
44

55
Welcome to API-KV, a user-friendly and versatile Key-Value storage API designed with simplicity in mind. Powered by
66
SQLite and implemented in Golang, API-KV offers an effortless experience for managing your data.
@@ -15,24 +15,16 @@ Features:
1515
in your preferred environment.
1616
- **Unbound experience**: Say goodbye to RAM limitations and the complexities of embedded DB-Per-App. API-KV, allows you
1717
to store everything on disk while maintaining efficient indexing and automatic removal of expired items.
18-
- **Namespaces**: No more conflicts between apps or pre-define databases. Organize keys in namespaces, which are
18+
- **Namespaces**: No more conflicts between apps or pre-defined databases. Organize keys in namespaces, which are
1919
dynamically created without restrictions.
2020

2121
Self-hosted friendly.
2222

23-
## Getting Started
24-
25-
To try out API-KV, follow these simple steps:
26-
27-
- Download the API-KV binary from our GitHub [releases](https://github.com/reddec/api-kv/releases/latest).
28-
- Run the binary on your machine.
29-
- Access the API and start storing and retrieving your key-value data effortlessly.
30-
3123
## Installation
3224

3325
- Via GitHub [releases](https://github.com/reddec/api-kv/releases/latest)
3426
- Via Go install: `go install -v github.com/reddec/api-kv/cmd/...@latest`
35-
- Via Docker image (x64 and arm): `ghcr.io/reddec/api-kv:latest`
27+
- Via [Docker image](https://github.com/reddec/api-kv/pkgs/container/api-kv) (x64 and arm): `ghcr.io/reddec/api-kv:latest`
3628

3729
## Usage
3830

0 commit comments

Comments
 (0)