Librarian

Librarian is the standard server implementation of TuiHub.

It is recommended to use with the standard client implementation Waiter. Check document site for user guide.

Usage

Server binary

Build the server with make, or download the binary file in releases page.

Config file

Config file is required. The config template is provided in configs

Command line arguments

• config path, eg: --conf config.yaml
• data path, eg: --data /opt/librarian/data

Environment variables

• LOG_LEVEL, accept debug, info, warn, error
• DEMO_MODE, accept true, false, server will reject any changes on admin user when demo mode is enabled
• CREATE_ADMIN_USER, accept a string
• CREATE_ADMIN_PASS, accept a string, server will create the given admin user on startup

Development

1. Install Go
2. (Optional) Install Docker and Docker Compose
3. (Optional) Deploy dependencies with tests/docker-compose.yml
4. Create the config file at configs/config.yaml with templates.
5. Run make run to start the server