https://github.com/ngalaiko/miniboard

Simple feeds reader.
https://github.com/ngalaiko/miniboard

reader rss

Last synced: about 2 months ago
JSON representation

Simple feeds reader.

• Host: GitHub
• URL: https://github.com/ngalaiko/miniboard
• Owner: ngalaiko
• License: gpl-3.0
• Created: 2019-08-20T15:39:04.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T04:57:22.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T18:51:24.826Z (6 months ago)
• Topics: reader, rss
• Language: Go
• Homepage: https://miniboard.app
• Size: 12.4 MB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Miniboard 

[![CI Status](https://github.com/ngalaiko/miniboard/workflows/CI/badge.svg)](https://github.com/ngalaiko/miniboard/actions)[![Coverage Status](https://coveralls.io/repos/github/ngalaiko/miniboard/badge.svg?branch=master)](https://coveralls.io/github/ngalaiko/miniboard?branch=master)[![Go Report Card](https://goreportcard.com/badge/github.com/ngalaiko/miniboard)](https://goreportcard.com/report/github.com/ngalaiko/miniboard)

## Configuration

### Backend

#### Command line arguments

| Command line            | Default                  | Description                    |

| ----------------------- | ------------------------ | ------------------------------ |

| config                  |                          | Path to the configuration file |

| verbose                 | false                    | Enable verbose logging         |

#### Configuration file

```yaml

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:

```bash

$ cd ./backend \

    && go run cmd/miniboard/main.go \

        --verbose \

        --config config.dev.yaml

```

2. Open browser:

```

$ open http://localhost/

```

## Acknowledgments 

* [Miniflux](https://miniflux.app)

* [Pinboard](https://pinboard.in)