Installation and Important Information

Installation

To run WooriDB it is necessary to have Rust installed in the machine. There are two ways to do this:

Go to rustup.rs and copy the command there, for unix it is curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh.
Clone WooriDB and execute make setup.

Executing WooriDB

Release mode performance: make release in project root for performance optimization.
Release mode size: make run in project root for size optimization.
Debug mode: make debug in project root.

Docker

You can find the latest docker image at naomijub/wooridb. Currently the most stable tag is beta-8. To execute the docker container run:

docker run -p 1438:1438 naomijubs/wooridb:beta-8 debug for debug mode.
docker run -p 1438:1438 -e AUTH_HASHING_COST=8 -e ADMIN=your-admin-id -e ADMIN_PASSWORD=your-admin-pswd naomijubs/wooridb:beta-8 run for size optimization.
docker run -p 1438:1438 -e AUTH_HASHING_COST=8 -e ADMIN=your-admin-id -e ADMIN_PASSWORD=your-admin-pswd naomijubs/wooridb:beta-8 release for performance optimization.
All -e/--env can be replaced by a --env-file path/to/your/.env. Your .env file should contain the following fields:

HASHING_COST=16
PORT=1438
SESSION_EXPIRATION_TIME=3600
MAX_CONNECTIONS=1000
CLIENT_SHUTDOWN=5000
AUTH_HASHING_COST=8
ADMIN=your-admin-id
ADMIN_PASSWORD=your-admin-pswd

Important Information

Responses are in RON format.
BLOB will not be supported. Check out To BLOB or Not To BLOB: Large Object Storage in a Database or a Filesystem.

Configurations

To run the project in debug mode it is important to export the following environment variables HASHING_COST, PORT, MAX_CONNECTIONS, CLIENT_SHUTDOWN. Default values are:

HASHING_COST=16
PORT=1438
MAX_CONNECTIONS=1000
CLIENT_SHUTDOWN=5000

MAX_CONNECTIONS is the maximum number of connections supported simultaneously.
CLIENT_SHUTDOWN is the time to drop a client's connection, use 0 to disable it.
To run the project in release mode it is important to export the following environment variables HASHING_COST, PORT, MAX_CONNECTIONS, CLIENT_SHUTDOWN, AUTH_HASHING_COST, ADMIN, ADMIN_PASSWORD, SESSION_EXPIRATION_TIME. There are no default values for AUTH_HASHING_COST, ADMIN, ADMIN_PASSWORD, SESSION_EXPIRATION_TIME.