- Notifications
You must be signed in to change notification settings - Fork4
Minimal Fever API (RSS Reader) Implementation
License
fanzeyi/lares
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Lares is a minimalFever API implementationwritten in Rust. It aims to provide a RSS reader backend with zero setup. Ituses SQLite 3 as storage engine.It does not provide an user interface.
It is recommended to use Reeder as client to lares.
Cargo
cargo install laresDocker
docker run -it fanzeyi/laresPre-built Binary
For each release, GitHub Action will attach pre-built binaries for Ubuntu,macOS and Windows. You can find these binaries in thereleasepage.
Lares consists of two parts, CLI and server. Feeds and groups are onlymanageable via the command line interface.
$ lares --helplares 0.2.1Minimal RSS serviceUSAGE: lares [FLAGS] [OPTIONS] <SUBCOMMAND>FLAGS: --debug -h, --help Prints help information -V, --version Prints version informationOPTIONS: -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 serverOr, to start a server:
$ lares server --helplares-server 0.2.1Starts web serverUSAGE: lares server [OPTIONS]FLAGS: -h, --help Prints help information -V, --version Prints version informationOPTIONS: -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 to127.0.0.1:4000 that only acceptsauthentication withlares andapassword and placing the SQLite databaseat/var/lares.db, run:
$ lares --database /var/lares.db server --host 127.0.0.1 --port 4000 \ --username lares --password apasswordIf you'd like to start a Lares host with Docker Compose, you may start withthis configuration:
version:'3'services:lares:image:fanzeyi/lares:latestports: -"127.0.0.1:4000:4000"restart:always# Uncomment this to persist the storage on the host.# volumes:# - ./run/lares:/var/laresenvironment:LARES_DATABASE:/var/lares/lares.dbLARES_HOST:0.0.0.0LARES_USERNAME:usernameLARES_PASSWORD:password
Then you can usedocker-compose exec lares lares to access Lares's commandline interface inside the container. For example, if you want to add a feed,use:
docker-compose exec lares lares feed add http://example.com/MIT
About
Minimal Fever API (RSS Reader) Implementation