ReductStore
Search
⌃K
Links
💡

Getting Started

Here you can learn how to start working with ReductStore

Start With Docker

The easiest way to start using ReductStore is to run Docker image:
docker run -p 8383:8383 -v ${PWD}/data:/data reduct/store:latest
The database will be available on port http://127.0.01:8383 and stores data in the ./data directory. You may check if it's working with a simple HTTP request:
curl http://127.0.0.1:8383/api/v1/info

Start With Snap

You can install the database with snap:
sudo snap install reductstore
ReductStore will be available on port http://127.0.01:8383 and store data in the /var/snap/reductstore/common/data directory.

Start With Cargo

Build Requirements:
  • Minimal Rust version: 1.66.0
  • OpenSSL 3 or later
  • Protobuf 3.17.3 or later
You can also install the database with cargo:
sudo apt install libssl-dev protobuf-compiler pkg-config
cargo install reductstore
RS_DATA_PATH=./data reductstore

Configuration

ReductStore can be configured with the following environmental variables:
Name
Default
Description
RS_LOG_LEVEL
INFO
Logging level, can be: TRACE, DEBUG, INFO, WARNING, ERROR
RS_HOST
0.0.0.0
Listening IP address
RS_PORT
8383
Listening port
RS_API_BASE_PATH
/
Prefix for all URLs of requests
RS_DATA_PATH
/data
Path to a folder where the storage stores the data
RS_API_TOKEN
​
If set, the storage uses token authorization​
RS_CERT_PATH
​
Path to an SSL certificate. If unset, the storage uses HTTP instead of HTTPS
RS_CERT_KEY_PATH
​
Path to the private key of the desired SSL certificate. Should be set with RS_CERT_PATH
If you use snap, you can configure the database by using the snap set command:
snap set reductstore log-level=DEBUG
This command change the log level to DEBUG and restarts the database. You can check the current configuration with the snap get reductstoret command:
snap get reductstore
Key Value
api-base /
api-token
cert-key-path
cert-path
data-path /var/snap/reductstore/common
host 0.0.0.0
log-level DEBUG
port 8383
Last modified 5d ago