MiniKV is a lightweight Key-Value Store designed to be accessed over HTTP. It offers simple yet efficient storage and retrieval of data through HTTP requests.
To get started with MiniKV, follow these steps:
-
Set up environment variables for authentication and logging:
$ export MINIKV_USERNAME=admin $ export MINIKV_PASSWORD=amoresecurepasswordthandefault $ export MINIKV_LOG_LEVEL=info
-
Launch MiniKV specifying the port (default port is
8899
):$ minikv -p 8899
MiniKV can be configured using CLI flags and environment variables.
-p
or--port
: Specify the TCP/IP port to bind to.--host
: Define the interface IP address to bind to.
MINIKV_USERNAME
: Set the username for HTTP Basic Authentication.MINIKV_PASSWORD
: Set the password for HTTP Basic Authentication.MINIKV_LOG_LEVEL
: Define the logging level (error
,warn
,info
,debug
,trace
).
- Rust toolchain
- Make
Follow these steps to install MiniKV:
-
Clone the repository:
$ git clone https://github.com/joshburnsxyz/minikv
-
Navigate to the project directory:
$ cd minikv
-
Build the project using Make:
$ make
-
Install MiniKV:
$ sudo make install