Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 3.06 KB

README.md

File metadata and controls

91 lines (67 loc) · 3.06 KB

What includes this image?

Docker image with rssbot. Documentation can be found here. Quick usage help:

USAGE:
    rssbot [FLAGS] [OPTIONS] <token>

FLAGS:
    -h, --help          Prints help information
        --insecure      DANGER: Insecure mode, accept invalid TLS certificates
        --restricted    Make bot commands only accessible for group admins
    -V, --version       Prints version information

OPTIONS:
        --admin <user id>...        Private mode, only specified user can use this bot. This argument can be passed
                                    multiple times to allow multiple admins
    -d, --database <path>           Path to database [default: ./rssbot.json]
        --max-feed-size <bytes>     Maximum feed size, 0 is unlimited [default: 2097152]
        --max-interval <seconds>    Maximum fetch interval [default: 43200]
        --min-interval <seconds>    Minimum fetch interval [default: 300]

ARGS:
    <token>    Telegram bot token

Note: You can get <user id> using bots like @userinfobot @getidsbot

Docker image

Registry Image
GitHub Container Registry ghcr.io/tarampampam/rssbot

All supported image tags (app versions) can be found here.

Following platforms for this image are available:

$ docker run --rm mplatform/mquery ghcr.io/tarampampam/rssbot:latest
Image: ghcr.io/tarampampam/rssbot:latest
 * Manifest List: Yes
 * Supported platforms:
   - linux/amd64
   - linux/arm64

Usage examples

$ docker run --rm -v "$(pwd):/rootfs:rw" \
    ghcr.io/tarampampam/rssbot:latest \
      --database /rootfs/rssbot.json \
      <telegram-bot-token>

Or you can use a docker-compose:

version: '3.2'

volumes:
  rssbot-data: {}

services:
  rssbot:
    image: ghcr.io/tarampampam/rssbot:latest
    volumes: [rssbot-data:/data:rw]
    command: ['--database', '/data/rssbot.json', '<telegram-bot-token>']

Releasing

New versions publishing is very simple - just "publish" new release using repo releases page. Release version should be same as the rssbot version.

License

WTFPL. Use anywhere for your pleasure.