πŸ’‘
Getting Started
Here you can learn how to start working with Reduct Storage
The current version supports Linux OS, MacOS and was tested on an AMD64 platform with EXT4 and XFS file systems.

Start With Docker

The easiest way to start using Reduct Storage is to run Docker image:
docker run -p 8383:8383 -v ${PWD}/data:/data reductstorage/engine:latest
The storage 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

Build Manually

To build the storage from source code, you need:
  • GCC 11.2 or higher
  • CMake 18 or higher
  • conan
On Ubuntu 21.10 or higher:
sudo apt install build-essential cmake python3-pip
sudo pip3 install conan
On Macos
brew install [email protected] python cmake
pip install conan
After all the requirements are installed, you can build the storage:
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . -- -j
Finally, you can launch the storage:
RS_DATA_PATH=./data bin/reduct-storage

Environment Variables

The storage can be customized 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
Last modified 4d ago
Copy link
Edit on GitHub
On this page
Start With Docker
Build Manually
Environment Variables