Lares: Minimal Fever API Implementation

Lares is a minimal Fever API implementation written in Rust. It aims to provide a RSS reader backend with zero setup. It uses SQLite 3 as storage engine. It does not provide an user interface.

It is recommended to use Reeder as client to lares.

Install

Cargo

cargo install lares

Docker

docker run -it fanzeyi/lares

Pre-built Binary

For each release, GitHub Action will attach pre-built binaries for Ubuntu, macOS and Windows. You can find these binaries in the release page.

Usage

Lares consists of two parts, CLI and server. Feeds and groups are only manageable via the command line interface.

$ lares --help
lares 0.2.1
Minimal RSS service

USAGE:
    lares [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
        --debug
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -d, --database <database>     [env: LARES_DATABASE=]  [default: lares.db]

SUBCOMMANDS:
    feed      Manages feeds
    group     Manages group
    help      Prints this message or the help of the given subcommand(s)
    server    Starts web server

Or, to start a server:

$ lares server --help
lares-server 0.2.1
Starts web server

USAGE:
    lares server [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -H, --host <host>            Specifies server host [env: LARES_HOST=]  [default: 127.0.0.1]
    -i, --interval <interval>    Specifies crawl interval (unit: minutes) [env: LARES_INTERVAL=]  [default: 30]
    -P, --password <password>    Specifies authentication password [env: LARES_PASSWORD=]
    -p, --port <port>            Specifies alternate port [env: LARES_PORT=]  [default: 4000]
    -u, --username <username>    Specifies authentication username [env: LARES_USERNAME=]

To start a lares server listens to 127.0.0.1:4000 that only accepts authentication with lares and apassword and placing the SQLite database at /var/lares.db, run:

$ lares --database /var/lares.db server --host 127.0.0.1 --port 4000 \
  --username lares --password apassword

Docker Compose

If you'd like to start a Lares host with Docker Compose, you may start with this configuration:

version: '3'
services:
  lares:
    image: fanzeyi/lares:latest
    ports:
      - "127.0.0.1:4000:4000"
    restart: always
    # Uncomment this to persist the storage on the host.
    # volumes:
    #  - ./run/lares:/var/lares
    environment:
      LARES_DATABASE: /var/lares/lares.db
      LARES_HOST: 0.0.0.0
      LARES_USERNAME: username
      LARES_PASSWORD: password

Then you can use docker-compose exec lares lares to access Lares's command line interface inside the container. For example, if you want to add a feed, use:

docker-compose exec lares lares feed add http://example.com/

License

MIT