egor3f/rssalchemy
1
0
Fork 0
Code Actions Packages Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Egor Aristov 2025-04-29 13:33:10 +03:00
parent 9a55cebb50
commit 843384e665
Signed by: egor3f
GPG Key ID: 40482A264AAEC85F
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -38,14 +38,12 @@ youtube
| Hosting | Self-hosting | Self-hosting | Self-hosting | Only cloud | | Hosting | Self-hosting | Self-hosting | Self-hosting | Only cloud |
| Price | Free and open-source | Free and open-source | Free and open-source | Paid ($8/mon) | | Price | Free and open-source | Free and open-source | Free and open-source | Paid ($8/mon) |
## Project status
Program is still under development. The code architecture is not final, no CI, etc...
## Demo instance ## Demo instance
[rssalchemy.efprojects.com](https://rssalchemy.efprojects.com) [rssalchemy.efprojects.com](https://rssalchemy.efprojects.com)
## Deployment ## Deployment
```bash ```bash
@ -58,6 +56,7 @@ Then open your browser targeting to port 8080.
For SSL, authentication, domains, etc. - use Caddy or Nginx (no specific configuration required). Personally I recommend Caddy, if you haven't used it before - give it a try :) For SSL, authentication, domains, etc. - use Caddy or Nginx (no specific configuration required). Personally I recommend Caddy, if you haven't used it before - give it a try :)
### Configuration ### Configuration
Configuration is done using environment variables Configuration is done using environment variables
@ -66,10 +65,18 @@ You can see all available options in [config.go file](internal/config/config.go)
Docker-compose deployment uses [deploy/.env file](deploy/.env) Docker-compose deployment uses [deploy/.env file](deploy/.env)
### Scaling ### Scaling
Each worker can process 1 page at a time, so to scale you should run multiple worker instances. This is done using replicas parameter in worker section in [docker-compose.yml file](deploy/docker-compose.yml) Each worker can process 1 page at a time, so to scale you should run multiple worker instances. This is done using replicas parameter in worker section in [docker-compose.yml file](deploy/docker-compose.yml)
### Troubleshooting FAQ
**Q: My RSS software shows timeout error, but rssalchemy logs are ok** <br/>
A: Increase timeout. For miniflux it's HTTP_CLIENT_TIMEOUT, for other clients - read their documentation <br/>
## Development ## Development
You need You need