update README.md
This commit is contained in:
27
README.md
27
README.md
@@ -3,3 +3,30 @@
|
|||||||
# ArcHIVE
|
# ArcHIVE
|
||||||
|
|
||||||
A lightweight in-memory database written in Rust
|
A lightweight in-memory database written in Rust
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### CLI
|
||||||
|
|
||||||
|
Download a binary or compile it yourself using `cargo build --release --bin archive-cli`
|
||||||
|
To compile the CLI and install it globally run `cargo install --path .`
|
||||||
|
|
||||||
|
### Server
|
||||||
|
|
||||||
|
#### Docker
|
||||||
|
|
||||||
|
The repository contains a simple `compose.yaml`
|
||||||
|
|
||||||
|
#### Binary
|
||||||
|
|
||||||
|
Alternatively you can run the server binary directly
|
||||||
|
Download a binary or compile it yourself using `cargo build --release --bin archive-server`
|
||||||
|
|
||||||
|
#### Environment variables
|
||||||
|
|
||||||
|
This is a list of the server's environment variables and their default values:
|
||||||
|
|
||||||
|
- SERVER_HOST=0.0.0.0
|
||||||
|
- SERVER_PORT=6171
|
||||||
|
- MAX_CONNECTIONS=256
|
||||||
|
- LOG_LEVEL=info
|
||||||
|
|||||||
Reference in New Issue
Block a user