Skip to content

Latest commit

 

History

History
245 lines (204 loc) · 9.3 KB

README_EN.md

File metadata and controls

245 lines (204 loc) · 9.3 KB

RSS Translator
Open Source, Lightweight, Self-hosted


| 中文 | Demo | Telegram Group | Development Progress

The main reason for development was to solve personal needs. I followed many foreign bloggers, but the English titles were not conducive to quick filtering, so I made an RSS translator.

Table of Contents

Functions:

  1. Translate titles or content
  2. Display bilingually
  3. Subscribe to translated RSS feeds or just proxy the original RSS feeds
  4. Add multiple translation engines, specifying one for each source
  5. Control the update frequency of translation sources and view translation status
  6. Cache all translated content to minimize translation costs
  7. View the tokens/characters consumed by each source

Currently supported translation engines:

  • DeepL
  • DeepLX
  • OpenAI
  • ClaudeAI
  • Azure OpenAI
  • Google Gemini
  • Google Translate(Web)
  • Microsoft Translate API
  • Caiyun API
  • Moonshot AI

We will add more translation engines soon.

Technology Stack

Django 5

Installation Requirements

System: (Ubuntu 22.04 LTS / Debian 12 / Fedora 37) or later
Memory: Recommended 512M or more
Python: >= 3.10

Installation Method

Automatic Installation (Recommended)

Download the installation script install_update.sh
wget "https://raw.githubusercontent.com/rss-translator/RSS-Translator/main/deploy/install_update.sh"

Use root to grant execution permissions, and this script can be run multiple times and can be used for updates

sudo chmod +x install_update.sh
sudo ./install_update.sh

After successful installation, access [http://127.0.0.1:8000]
Default account: admin
Default password: rsstranslator
Please change your password after logging in
If you need to enable SSL (https), please refer to here

One-click Deployment

Deploy on Railway

Install via Docker

Use Docker Compose (Recommended)
Download the docker-compose.yml file
wget "https://raw.githubusercontent.com/rss-translator/RSS-Translator/main/deploy/docker-compose.yml"
Run docker-compose -f docker-compose.yml up -d
Installation complete, visit http://127.0.0.1:8000

Use Docker

docker run -d \
  -v data:/home/rsstranslator/data \
  -p 8000:8000 --restart always \
  rsstranslator/rsstranslator \
  bash -c "python manage.py init_server && python manage.py run_huey & uvicorn config.asgi:application --host  0.0.0.0"

Installation complete, visit http://127.0.0.1:8000

Manual Installation

Install necessary software
sudo apt install python3-venv git zip -y
Download the project
git clone https://github.com/rss-translator/RSS-Translator.git
Create executing user

sudo useradd -r -s /sbin/nologin rsstranslator
sudo usermod -a -G rsstranslator your_user_name

Move folders and correct permissions

mv -f RSS-Translator /home/rsstranslator
mkdir /home/rsstranslator/data
sudo chown -R rsstranslator:rsstranslator /home/rsstranslator
sudo chmod -R 775 /home/rsstranslator
sudo chmod a+x /home/rsstranslator/deploy/*.sh

Create virtual environment
sudo -u rsstranslator /bin/bash -c "python3 -m venv /home/rsstranslator/.venv"\

Install dependencies
sudo -u rsstranslator /bin/bash -c "/home/rsstranslator/.venv/bin/pip install -q -r /home/rsstranslator/requirements/prod.txt"
Create service
sudo nano /etc/systemd/system/rsstranslator.service
Paste and modify the following content

[Unit] Description=RSS Translator Application Service After=network.target

[Service] Type=simple
User=rsstranslator
Group=rsstranslator
WorkingDirectory=/home/rsstranslator/
ExecStart=/home/rsstranslator/deploy/start.sh
Restart=always RestartSec=2

[Install] WantedBy=multi-user.target

Restart daemon and enable startup at boot

sudo systemctl daemon-reload
sudo systemctl enable rsstranslator.service

Initialize runtime environment

sudo -u rsstranslator /bin/bash -c "/home/rsstranslator/.venv/bin/python /home/rsstranslator/manage.py makemigrations"
sudo -u rsstranslator /bin/bash -c "/home/rsstranslator/.venv/bin/python /home/rsstranslator/manage.py migrate"
sudo -u rsstranslator /bin/bash -c "/home/rsstranslator/.venv/bin/python /home/rsstranslator/manage.py collectstatic --noinput"
sudo -u rsstranslator /bin/bash -c "/home/rsstranslator/.venv/bin/python /home/rsstranslator/manage.py create_default_superuser"

Start the service
systemctl start rsstranslator.service Check the service status
systemctl status rsstranslator.service Installation complete, visit http://127.0.0.1:8000

Error: CSRF Verification Failed

If you encounter a 403 CSRF verification failed error after logging in, you need to set the environment variable CSRF_TRUSTED_ORIGINS, the value is the domain name or IP address: https://*.example.com

Upgrade

sudo . /home/rsstranslator/deploy/install_update.sh

Uninstall

sudo . /home/rsstranslator/deploy/uninstall.sh Note: This uninstall script does not delete the data backup files in the /tmp directory, just in case!

Enable SSL

It is recommended to use caddy with cloudflare's dns proxy. Install Caddy: https://caddyserver.com/docs/install#debian-ubuntu-raspbian

Create caddy configuration file
You can refer to /home/rsstranslator/deploy/Caddyfile for modification, normally you just need to modify the domain name in the first line. sudo nano /home/rsstranslator/deploy/Caddyfile\ The content is as follows. `` example.com { encode zstd gzip #tls internal handle_path /static/* { root * /home/rsstranslator/static/ file_server }

    handle_path /media/* {
            root * /home/rsstranslator/media/ file_server } handle_path /media/* { root * /home/rsstranslator/static/
            file_server
    }

    reverse_proxy 127.0.0.1:8000

}

Once you've made the changes, copy the configuration file and restart it

sudo mv /etc/caddy/Caddyfile /etc/caddy/Caddyfile.back sudo cp /home/rsstranslator/deploy/Caddyfile /etc/caddy/ sudo systemctl reload caddy `` If dns proxy is enabled in cloudflare, you need to select Full for encryption mode on the SSL/TLS page in cloudflare.

IPv6

IPv4 and IPv6 cannot be supported at the same time;
If you want set the server to listen on IPv6 address, just edit the deploy/start.sh file, change 0.0.0.0 to ::, then restart the service.

Usage Guide

After login for the first time, it is recommended to change the default password by clicking Change Password on the top right. It is recommended to add the translation engine first before adding the feed, unless you just want to proxy the source. After adding the feed for the first time, it will take some time to translate and generate it, it may take about 1 minute
Status Note:
! loading: being processed
! yes: Processing completed
! no: Processing failed
The current status will not be updated automatically, please refresh the page to get the latest status.

Sponsorship

Thank you to JetBrains for providing the open source license for this project.

JetBrains Black Box Logo logo.

Thank you for your sponsorship:

Please consider becoming a sponsor: AFDIAN | Open Collective

Contribution

Please check the Wiki

Star History

Star History Chart