chore: bump version to v0.5.1

.env.sample

@@ -5,7 +5,7 @@ PORT=8080
 DB_DIR="/db/rsslay.sqlite"
 DEFAULT_PROFILE_PICTURE_URL="https://i.imgur.com/MaceU96.png"
 SECRET="CHANGE_ME"
-VERSION=0.5.0
+VERSION=0.5.1
 REPLAY_TO_RELAYS=false
 RELAYS_TO_PUBLISH_TO=""
 NITTER_INSTANCES=""
@@ -21,6 +21,4 @@ INFO_CONTACT=""
 MAX_CONTENT_LENGTH=250
 LOG_LEVEL=WARN
 DELETE_FAILING_FEEDS=false
-REDIS_ADDRESS=""
-REDIS_USERNAME=""
-REDIS_PASSWORD=""
+REDIS_CONNECTION_STRING=""

Dockerfile

@@ -28,7 +28,7 @@ ENV PORT="8080"
 ENV DB_DIR="/db/rsslay.sqlite"
 ENV DEFAULT_PROFILE_PICTURE_URL="https://i.imgur.com/MaceU96.png"
 ENV SECRET="CHANGE_ME"
-ENV VERSION=0.5.0
+ENV VERSION=0.5.1
 ENV REPLAY_TO_RELAYS=false
 ENV RELAYS_TO_PUBLISH_TO=""
 ENV NITTER_INSTANCES=""
@@ -44,9 +44,7 @@ ENV INFO_CONTACT=""
 ENV MAX_CONTENT_LENGTH=250
 ENV LOG_LEVEL="WARN"
 ENV DELETE_FAILING_FEEDS=false
-ENV REDIS_ADDRESS=""
-ENV REDIS_USERNAME=""
-ENV REDIS_PASSWORD=""
+ENV REDIS_CONNECTION_STRING=""
 
 COPY --from=build /rsslay .
 COPY --from=build /app/web/assets/ ./web/assets/

Dockerfile.fly

@@ -30,7 +30,7 @@ ENV PORT="8080"
 ENV DB_DIR="/db/rsslay.sqlite"
 ENV DEFAULT_PROFILE_PICTURE_URL="https://i.imgur.com/MaceU96.png"
 ENV SECRET="CHANGE_ME"
-ENV VERSION=0.5.0
+ENV VERSION=0.5.1
 ENV REPLAY_TO_RELAYS=false
 ENV RELAYS_TO_PUBLISH_TO=""
 ENV NITTER_INSTANCES=""
@@ -46,9 +46,7 @@ ENV INFO_CONTACT=""
 ENV MAX_CONTENT_LENGTH=250
 ENV LOG_LEVEL="WARN"
 ENV DELETE_FAILING_FEEDS=false
-ENV REDIS_ADDRESS=""
-ENV REDIS_USERNAME=""
-ENV REDIS_PASSWORD=""
+ENV REDIS_CONNECTION_STRING=""
 
 COPY --from=litefs /usr/local/bin/litefs /usr/local/bin/litefs
 COPY --from=build /rsslay /usr/local/bin/rsslay

Dockerfile.railwayapp

@@ -57,9 +57,7 @@ ARG INFO_CONTACT
 ARG MAX_CONTENT_LENGTH
 ARG LOG_LEVEL
 ARG DELETE_FAILING_FEEDS
-ARG REDIS_ADDRESS
-ARG REDIS_USERNAME
-ARG REDIS_PASSWORD
+ARG REDIS_CONNECTION_STRING
 
 LABEL org.opencontainers.image.title="rsslay"
 LABEL org.opencontainers.image.source=https://github.com/piraces/rsslay
@@ -71,7 +69,7 @@ ENV PORT=$PORT
 ENV DB_DIR=$DB_DIR
 ENV DEFAULT_PROFILE_PICTURE_URL=$DEFAULT_PROFILE_PICTURE_URL
 ENV SECRET=$SECRET
-ENV VERSION=0.5.0
+ENV VERSION=0.5.1
 ENV REPLAY_TO_RELAYS=false
 ENV RELAYS_TO_PUBLISH_TO=""
 ENV NITTER_INSTANCES=""
@@ -87,9 +85,7 @@ ENV INFO_CONTACT=""
 ENV MAX_CONTENT_LENGTH=250
 ENV LOG_LEVEL="WARN"
 ENV DELETE_FAILING_FEEDS=false
-ENV REDIS_ADDRESS=$REDIS_ADDRESS
-ENV REDIS_USERNAME=$REDIS_USERNAME
-ENV REDIS_PASSWORD=$REDIS_PASSWORD
+ENV REDIS_CONNECTION_STRING=$REDIS_CONNECTION_STRING
 
 COPY --from=build /rsslay .
 COPY --from=build /app/web/assets/ ./web/assets/

README.md

@@ -65,6 +65,18 @@ If you want to run your own instance, you are covered!
 Several options (including "one-click" ones) are available.
 Checkout [the wiki](https://github.com/piraces/rsslay/wiki/Deploy-your-own-instance).
 
+## Caching
+
+Since version v0.5.1, rsslay uses cache by default (in-memory with [BigCache](https://github.com/allegro/bigcache) by default or with [Redis](https://redis.io/) if configured) enabled by default to improve performance.
+In the case of the main instance `rsslay.nostr.moe`, Redis is used in HA mode to improve performance for multiple requests for the same feed.
+
+**Nevertheless, there is a caveat using this approach that is that cached feeds do not refresh for 30 minutes (but I personally think it is worth for the performance gain).**
+
+## Metrics
+
+Since version v0.5.1, rsslay uses [Prometheus](https://prometheus.io/) instrumenting with metrics exposed on `/metrics` path.
+So with this you can mount your own [Graphana](https://grafana.com/) dashboards and look into rsslay insights!
+
 # Contributing
 
 Feel free to [open an issue](https://github.com/piraces/rsslay/issues/new), provide feedback in [discussions](https://github.com/piraces/rsslay/discussions), or fork the repo and open a PR with your contribution!

fly.toml

@@ -29,7 +29,7 @@ kill_timeout = 5
  PORT = "8080"
  RELAYS_TO_PUBLISH_TO = "wss://nostr.data.haus,wss://relay.nostrgraph.net,wss://nostr.mom,wss://relay.nostr.band,wss://nostr.mutinywallet.com"
  REPLAY_TO_RELAYS = "true"
- VERSION = "0.5.0"
+ VERSION = "0.5.1"
 
 [[mounts]]
  source = "rsslay_data_machines"