freshrss-image-cache-service-rs

A simple service for caching images locally, specifically designed for the freshrss-image-cache-plugin extension. This can be particularly useful in the case of time-limited links to images (e.g. in the case of rsshub.app).

This is an alternative implementation of the caching service, a drop-in replacement for the piccache.php.

Quick Start

To start the service locally for development, run just one command:

make start

Docker Image

Here is an example of a Docker Compose configuration for quick deployment:

# $ cat compose.yaml

services:
  cache_server:
    image: ghcr.io/s373r/freshrss-image-cache-service-rs:latest
    ports:
      - 3000:3000
    volumes:
      - ./images:/usr/src/app/images
    environment:
      - APP_PORT=3000
      - APP_ACCESS_TOKEN=TODO_REPLACE_ME_WITH_RANDOM_VALUE
      - APP_IMAGES_DIR=./images
      - APP_NO_ANSI_COLORS=1

⚠️ Make sure to replace APP_ACCESS_TOKEN with a unique value!

Release procedure

make lint
make image
make image-push