https://github.com/timofurrer/influss
[WIP!] Minimalist self-hosted read-it-later server that only produces an RSS feed.
https://github.com/timofurrer/influss
Last synced: 4 months ago
JSON representation
[WIP!] Minimalist self-hosted read-it-later server that only produces an RSS feed.
- Host: GitHub
- URL: https://github.com/timofurrer/influss
- Owner: timofurrer
- License: mit
- Created: 2025-01-25T08:43:59.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-02-14T16:09:55.000Z (11 months ago)
- Last Synced: 2025-02-14T16:32:56.426Z (11 months ago)
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# influss
Minimalist self-hosted read-it-later server that just produces an RSS feed.
## Host influss
influss can easily be self-hosted. It's a single Go binary and currently
supports storing the clipped websites in a file system directory.
```shell
docker run -d --name influss -p 8080:8080 -v $(pwd)/influss-store:/store ghcr.io/timofurrer/influss/influss
```
Running influss with `docker compose` makes configuration a little bit easier:
```yaml
services:
influss:
image: ghcr.io/timofurrer/influss/influss:1.0.28
ports:
- "8080:8080"
volumes:
- store:/var/lib/influss/store
command:
- '--listen-addr=:8080'
- '--use-local-store=true'
- '--local-store-dir=/var/lib/influss/store'
- '--feed-title=Read it later (Influss)'
- '--feed-author-name='
- '--feed-author-email='
- '--feed-link=/clips'
- '--feed-description=Read it later RSS feed produced by Influss'
volumes:
store:
```
influss does not come with any means of authentication.
Therefore, we recommend running it behind a reverse proxy that
also takes care of authentication. We recommend [caddy](https://caddyserver.com/).
Configure simple HTTP basic auth with your reverse proxy for influss:
```caddyfile
influss. {
basicauth /* {
}
reverse_proxy localhost:8080
}
```
Use [`caddy hash-password`](https://caddyserver.com/docs/command-line#caddy-hash-password)
to hash the password for the `Caddyfile` configuration.
## Configure RSS reader
Configure your RSS reader to point to `influss./clips` and optionally
use the HTTP basic auth credentials.
We recommend [miniflux](https://miniflux.app/) as the RSS reader.
## Install browser extension
influss currently only provides a Firefox Add-on.
The extension page is [here](https://addons.mozilla.org/de/android/addon/9ed557601ec54aaeb32f)
However, you may already install the add-on from the [`extensions`](./extensions)
directory.
### Configure
To configure the browser extension go to its settings and configure
the endpoint, username and password.