Giter VIP home page Giter VIP logo

librarian's Introduction

Librarian

Go Report Card golangci-lint codecov

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

librarian's People

Contributors

muzhou233 avatar renovate[bot] avatar github-actions[bot] avatar fossabot avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.