Skip to content

Colin-XKL/rss-feed-translator

Repository files navigation

rss-feed-translator

MIT License

English | 中文说明

Translate your rss and atom feed in an easy way.

Features

  • RSS & Atom feed support
  • Translate between many language
  • Support custom translate api token for better experience
  • Free translate endpoint by default to make it easy to have a try

Installation

Docker image is available here

sudo docker run -d --name rss-feed-translator -p 10050:6000 ghcr.io/colin-xkl/rss-feed-translator:v1.0.0

docker compose example

version: '3.3'
services:
  rss-feed-translator:
    image: 'ghcr.io/colin-xkl/rss-feed-translator:v1.0.0'
    container_name: feed-translator
    ports:
      - '10050:6000'
    environment:
      - ALIYUN_ACCESS_KEY_ID=xxxxx
      - ALIYUN_ACCESS_KEY_SECRET=xxxxxx
    restart: always

Run Locally

Clone the project, and run app.py

# update pip and install poetry
# ensure use python3
pip install -U pip setuptools
pip install poetry

# install dependencies
poetry install

# run
python3 app.py

Config

common environment variables:

  • FLASK_DEBUG true or false to enable debug
  • LOGGING_LEVEL DEBUG|INFO|WARNING|ERROR|CRITICAL
  • PORT default 6000
  • SENTRY_DSN set this for use sentry to track errors

translation platforms tokens env vars:
reference the detail documents in the docs dir of this repo.

Used By

This project is used by the following projects:

  • RSS Man X

Currently supported translator

  • DeepL (Free, slow)
  • Aliyun (Token needed, fast, free tier available)

Screenshots

Compare: original feed and translated feed

Compare: translated feed in Reeder app

Homepage of the project

Roadmap

  • Additional translation backend support

  • Add more support for easy setup

  • More translation mode, such as inline translation

License

MIT