# Release-bot

Release-bot is a self-hosted automation app. A Telegram bot that monitors the releases of given repos, sending messages upon a new release. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/3271/release-bot

## Description

A Telegram bot that monitors the releases of given repos, sending messages upon a new release.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

56/100 (Fair), based on 4 of 5 factors.
- Maintained: 60 (last commit 157 days ago)
- Popular: 37 (69 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 95 (no serious findings, CI, tests)

## Links

- Unraid: https://ca.unraid.net/apps/release-bot-056d5mn0v9xe23?q=release-bot

## Common questions

### Do I need a public IP or domain to run release-bot?

No, it can work locally without a white IP and domain name. Only a Telegram bot token is required.

### Is a GitHub token required for release-bot?

No, GITHUB_TOKEN is optional. Without it the bot works well for about 20 repos, while a classic or fine-grained GitHub token can be set if needed.

### How do I keep release-bot data when using Docker?

Mount a host directory to /app/data as a volume in Docker Compose or docker run.

### Which port does the Docker example use for release-bot?

The Docker examples map host port 5000 to container port 5000.

### What ways can I subscribe release-bot to repositories?

You can subscribe by owner/name, GitHub, PyPI, or npm URL, upload a requirements.txt or package.json file, or subscribe to starred repos.

---
Source: Our Local Host (https://ourlocalhost.com/app/3271/release-bot), the self-hosted and open-source app directory.
