GithubHelp home page GithubHelp logo

ngalaiko / miniboard Goto Github PK

View Code? Open in Web Editor NEW
8.0 2.0 0.0 12.65 MB

Simple feeds reader.

Home Page: https://miniboard.app

License: GNU General Public License v3.0

Go 92.74% HTML 4.45% JavaScript 2.28% CSS 0.52%
rss reader

miniboard's Introduction

Miniboard

CI StatusCoverage StatusGo Report Card

Configuration

Backend

Command line arguments

Command line Default Description
config Path to the configuration file
verbose false Enable verbose logging

Configuration file

db:
  addr: "sqlite3://db.sqilite3" # db address
  max_open_connections: 1       # max open connections to db
http:
  addr: ":8080" # address to listen on
  tls:
    enabled: true          # if false, plaintext http will be used
    key_path: "./key.pem"  # path to tls key
    cert_path: "./crt.pem" # path to tls certificate
subsciptions:
  updates:
    workers: 10  # number of workers that update subscriptions in background
    interval: 5m # interval between feed updates
users:
  bcrypt_cose: 14 # bcrypt cost
web:
  fs: true      # if true, files will be served from the filesystem
  gzip_level: 5 # gzip compression level

Environment variables

It is also possible to define any configuration value by setting an environment value, for example:

  • MINIBOARD_HTTP_ADDR will override http.addr
  • MINIBOARD_DB_DRIVER will override db.driver
  • etc.

Development

  1. Run server:
$ cd ./backend \
    && go run cmd/miniboard/main.go \
        --verbose \
        --config config.dev.yaml
  1. Open browser:
$ open http://localhost/

Acknowledgments

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.