mirror of
https://github.com/nkanaev/yarr.git
synced 2025-05-24 00:33:14 +00:00
71 lines
1.9 KiB
Markdown
71 lines
1.9 KiB
Markdown
# yarr
|
|
|
|
**yarr** (yet another rss reader) is a web-based feed aggregator which can be used both
|
|
as a desktop application and a personal self-hosted server.
|
|
|
|
It is written in Go with the frontend in Vue.js. The storage is backed by SQLite.
|
|
|
|
|
|
|
|
## usage
|
|
|
|
The latest prebuilt binaries for Linux/MacOS/Windows are available
|
|
[here](https://github.com/nkanaev/yarr/releases/latest).
|
|
|
|
### macos
|
|
|
|
Download `yarr-*-macos64.zip`, unzip it, place `yarr.app` in `/Applications` folder.
|
|
To open the app follow the instructions provided [here][macos-open] or run the command below:
|
|
|
|
xattr -d com.apple.quarantine /Applications/yarr.app
|
|
|
|
[macos-open]: https://support.apple.com/en-gb/guide/mac-help/mh40616/mac
|
|
|
|
### windows
|
|
|
|
Download `yarr-*-windows32.zip`, unzip it, open `yarr.exe`
|
|
|
|
### linux
|
|
|
|
The Linux version doesn't come with the desktop environment integration.
|
|
For easy access on DE it is recommended to create a desktop menu entry by
|
|
by following the steps below:
|
|
|
|
unzip -x yarr*.zip
|
|
sudo mv yarr /usr/local/bin/yarr
|
|
sudo nano /usr/local/share/applications/yarr.desktop
|
|
|
|
and pasting the content:
|
|
|
|
[Desktop Entry]
|
|
Name=yarr
|
|
Exec=/usr/local/bin/yarr -open
|
|
Icon=rss
|
|
Type=Application
|
|
Categories=Internet;
|
|
|
|
For self-hosting, see `yarr -h` for auth, tls & server configuration flags.
|
|
|
|
## build
|
|
|
|
Install `Go >= 1.16` and `gcc`. Get the source code:
|
|
|
|
git clone https://github.com/nkanaev/yarr.git
|
|
|
|
Then run one of the corresponding commands:
|
|
|
|
# create an executable for the host os
|
|
make build_macos # -> _output/macos/yarr.app
|
|
make build_linux # -> _output/linux/yarr
|
|
make build_windows # -> _output/windows/yarr.exe
|
|
|
|
# ... or start a dev server locally
|
|
make serve # starts a server at http://localhost:7070
|
|
|
|
# ... or build a docker image
|
|
docker build -t yarr .
|
|
|
|
## credits
|
|
|
|
[Feather](http://feathericons.com/) for icons.
|