Git Product home page Git Product logo

mini-board's Introduction

Mini Board

Mini Board is a minimal UI for Board.

Installation

With Docker

docker pull saramorillon/mini-board:latest

With docker-compose

You can use the docker-compose.yml provided as an example.

โš ๏ธ Make sure that the data, sessions and logs folder are writable by the container user (uid: 1000 - gid: 1000)

Using source code (production)

  • Download the latest release of mini-board
  • Install packages using command yarn install --production
  • Make sure that your system is configured with the appropriate environment variables (see below)
  • Run project using command yarn start

Using source code (development)

  • Download the latest release of mini-board
  • Install packages using command yarn install
  • Rename .env.template to .env and fill it with appropriate values
  • Run project using command yarn start:dev

Running Mini Board

Mini Board listens to port 80 by default.

The default credentials are admin/admin.

Environment variables

Variable Value type Default value Description
NODE_ENV development | production Environment of the application
APP_KEY string App key for session
APP_PORT number 80 App port
COOKIE_DOMAIN string Domain of the session cookie
COOKIE_HTTP_ONLY boolean true Should the session cookie be http only
COOKIE_SECURE boolean true Should the session cookie be secure
COOKIE_MAX_AGE string 1h Max age of the session cookie (ms)
SESSION_DIR string Directory to store session
UPLOAD_DIR string Directory where attachments are uploaded
DATABASE_URL string URL of the database

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.