diff --git a/README.md b/README.md index 56c3f8b..b2ba256 100644 --- a/README.md +++ b/README.md @@ -38,14 +38,12 @@ youtube | 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) | -## Project status - -Program is still under development. The code architecture is not final, no CI, etc... ## Demo instance [rssalchemy.efprojects.com](https://rssalchemy.efprojects.com) + ## Deployment ```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 :) + ### Configuration 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) + ### 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) + +### Troubleshooting FAQ + +**Q: My RSS software shows timeout error, but rssalchemy logs are ok**
+A: Increase timeout. For miniflux it's HTTP_CLIENT_TIMEOUT, for other clients - read their documentation
+ + ## Development You need