summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--content/yarr.md49
-rw-r--r--static/pix/yarr.svg2
2 files changed, 24 insertions, 27 deletions
diff --git a/content/yarr.md b/content/yarr.md
index d649f61..6882fa1 100644
--- a/content/yarr.md
+++ b/content/yarr.md
@@ -1,53 +1,50 @@
---
title: "Yarr"
-date: 2022-06-28
-pix: 'yarr.svg'
+date: 2022-07-01
icon: 'yarr.svg'
tags: ['service']
short_desc: 'A self-hosted, web-based feed aggregator'
---
-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.
-
+[Yarr](https://github.com/nkanaev/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.
-
-More information can be found on the [github](https://github.com/nkanaev/yarr)
-
+
## Installing Yarr
Firstly, we have to download yarr binary from github on our system
-
+
```sh
wget https://github.com/nkanaev/yarr/releases/download/v2.3/yarr-v2.3-linux64.zip
```
-
+
Unzip the archive
```sh
unzip -x yarr-v2.3-linux64.zip
```
-
+
Move the binary to your bin folder
-```sh
-sudo mv yarr /usr/local/bin/yarr
+```sh
+mv yarr /usr/local/bin/yarr
```
-
+
## Configuration
-
-Now we need to create a auth.conf file that include user and password to create a local yarr account.
-I personnaly store this file in a directory called yarr in ~/.config folder, but you can place the file wherever you want.
+
+Now we need to create a `auth.conf` file that include user and password to create a local yarr account.
+I personnaly store this file in a directory called yarr in `~/.config` folder, but you can place the file wherever you want.
```sh
mkdir ~/.config/yarr
echo 'landchad:password' > ~/.config/yarr/auth.conf
```
-
+
## Creating a service
-
+
Create a new file /etc/systemd/system/yarr.service and add the following:
-```systemd
+```systemd
[Unit]
Description=Yarr
@@ -62,7 +59,7 @@ WantedBy=multi-user.target
After creating the config, load, start and enable the service with the following commands.
-```sh
+```sh
systemctl daemon-reload
systemctl enable --now yarr
```
@@ -74,7 +71,7 @@ Create an Nginx configuration file for Yarr, say /etc/nginx/sites-available/yarr
server {
listen 80 ;
listen [::]:80 ;
-
+
server_name rss.example.org ;
location / {
@@ -85,20 +82,20 @@ server {
Now let's enable the Nginx Yarr site and reload Nginx to make it active.
-```sh
+```sh
ln -s /etc/nginx/sites-available/yarr /etc/nginx/sites-enabled
systemctl reload nginx
```
### Encryption
-
+
You can encrypt your yarr subdomain as well. Let's do that with certbot:
-```sh
+```sh
certbot --nginx -d rss.example.org
```
-Now you can go to rss.example.org, login and start to add your feeds !
-
+Now you can go to rss.example.org, login and start to add your feeds!
+
## Contribution
Author: Jppaled -- [jppaled.xyz](https://jppaled.xyz) \-- XMR: `86bVp8bcx1F3y3NsfuTRs6D7FfnDyLomV7dLJmus2YMiY9Aat6W5m8JGwuvH39HKrq3immS7noKq8HeW4gb4BFbyLoz5WSZ`{.crypto}
diff --git a/static/pix/yarr.svg b/static/pix/yarr.svg
index 35be6fa..bedae7c 100644
--- a/static/pix/yarr.svg
+++ b/static/pix/yarr.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-anchor"><circle cx="12" cy="5" r="3"/><line x1="12" y1="22" x2="12" y2="8"/><path d="M5 12H2a10 10 0 0 0 20 0h-3"/></svg> \ No newline at end of file
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="white" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-anchor"><circle cx="12" cy="5" r="3"/><line x1="12" y1="22" x2="12" y2="8"/><path d="M5 12H2a10 10 0 0 0 20 0h-3"/></svg>