/bsky-rss-bot

[HEAVY WIP] A simple RSS feed subscriber -> Bluesky post bot.

Primary LanguageTypeScriptMIT LicenseMIT

Bluesky RSS Bot

Important

This project will break release-to-release until stablised! There is no promise of stability or compatibility between versions until v1. You have been warned.

A simple RSS feed subscriber -> Bluesky post bot.

Features

  • Follow multiple feeds and post to the same account.
  • Posts automatically backdated and fetched X hours from before bot startup.
  • Duplicate post detection via URL stored in persistent database.
  • Link embedding with image support.

Setup

Docker

(The docker image will be uploaded in the coming days, for now you will need to build from the local image)

  1. Copy the following to a local file named docker-compose.yml or add the service to your existing stack and fill in the environment variables. Information about configuration options can be found in the configuration section.
services:
    bsky-rss-bot:
        image: ghcr.io/blooym/bsky-rss-bot
        restart: unless-stopped
        environment:
            - APP_SERVICE=
            - APP_IDENTIFIER=
            - APP_PASSWORD=
            - RSS_FEED_URLS=
            - RSS_CRON_INTERVAL_MINUTES=
            - RSS_FEED_FETCH_PAST_HOURS=
            - POSTING_LANGUAGES=
            - DISABLE_POST_COMMENTS=
        volumes:
            - bsky-rss-bot-data:/opt/bsky-rss-bot/data

volumes:
    bsky-rss-bot-data:
  1. Start the stack
docker compose up -d

Manual

  1. Ensure you have Deno installed and in your $PATH.
  2. Clone the repository
git clone https://github.com/Blooym/bsky-rss-bot.git

  1. Copy .env.example to .env and fill in the values as necessary. Information about configuration options can be found in the configuration section.

  2. Run the project

deno run --unstable-cron --allow-read --allow-env --allow-ffi --allow-write --allow-net src/main.ts

Configuration

Configuration is handled entirely through environment variables, usually using either docker directly or .env.

  • APP_SERVICE: The full URL to the service to communicate with. Most users will want to use https://bsky.social
  • APP_IDENTIFIER: The username or email of the application's account.
  • APP_PASSWORD: The app password to use when authenticating.
  • RSS_FEED_URLS: A comma-seperated list of RSS feed urls.
  • RSS_CRON_INTERVAL_MINUTES: The interval of time in minutes to check for new posts .
  • RSS_FEED_FETCH_PAST_HOURS: The number of hours in the past the bot should check for posts that haven't been posted at startup. Useful for backdating an account or when an outage occurs.
  • POSTING_LANGUAGES: A comma-seperated list of languages in ISO-639-1 to classify posts under. This should corrolate to the language of the posts the feed is linking to.
  • DISABLE_POST_COMMENTS: A boolean value indicating whether or not Bluesky posts should have comments disabled.