Sign inSign up

myanesp/telegram-immich-bot

By myanesp

•Updated 8 months ago

Telegram bot to upload files directly to your Immich instance

Image
API management
2

1.3K

myanesp/telegram-immich-bot repository overview

⁠Telegram to Immich Bot

GitHub Docker Docker Pulls Last Commit License Project Status: Active

⁠Why?

This Docker container provides a simple way to automatically upload files from Telegram to your Immich photo management system. It's perfect for:

  • Automatically backing up photos/videos sent to a Telegram bot
  • Creating a simple upload pipeline for your personal media
  • Integrating Telegram with your self-hosted photo management system

⁠Features

✅ Automatic file uploads from Telegram to Immich ✅ Preserves original file metadata (for images) ✅ User restriction control (only allow specific Telegram user IDs) ✅ Simple configuration via environment variables

⁠How to Run

  1. Set up your Telegram bot:

    • Create a new bot using @BotFather⁠
    • Note down your bot token
    • Start a chat with your new bot
  2. Configure your Immich instance:

    • Ensure your Immich API is accessible from the host
    • Generate an API key from your Immich settings
  3. Run the container and send a file! This image is available both on Docker Hub⁠ and GitHub Container Registry⁠, so you're free to choose from which one you're going to download the image. Edit the following docker compose/docker run command to match your needs and you are ready to go!

⁠Run with Docker Compose
version: '3'
services:
  telegram-immich-bot:
    image: ghcr.io/myanesp/telegram-immich-bot:latest # or myanesp/telegram-immich-bot
    container_name: telegram-immich-bot
    restart: unless-stopped
    environment:
      - TELEGRAM_BOT_TOKEN=your_telegram_bot_token
      - IMMICH_API_URL=http://your-immich-instance/api
      - IMMICH_API_KEY=your_immich_api_key
      - ALLOWED_USER_IDS=user1_id,user2_id # Optional: restrict to specific users
⁠Run with Docker run
docker run -d \
  --name telegram-immich-bot \
  --restart unless-stopped \
  -e TELEGRAM_BOT_TOKEN=your_telegram_bot_token \
  -e IMMICH_API_URL=http://your-immich-instance/api \
  -e IMMICH_API_KEY=your_immich_api_key \
  -e ALLOWED_USER_IDS=user1_id,user2_id \ # Optional
  ghcr.io/myanesp/telegram-immich-bot:latest # or myanesp/telegram-immich-bot

⁠Environment Variables

VARIABLEMANDATORYDESCRIPTIONDEFAULT
TELEGRAM_BOT_TOKEN✅Your Telegram bot token obtained from @BotFather-
IMMICH_API_URL✅Full URL to your Immich API endpoint (can be local or public) (e.g., http://your-immich-instance:2283/api)-
IMMICH_API_KEY✅API key for authenticating with your Immich instance-
ALLOWED_USER_IDS❌Comma-separated list of Telegram user IDs allowed to use the bot (e.g., 123456789,987654321)(empty - all users allowed)

⁠Planned features

  • Multiarch support
  • Multilingual support
  • Reduce Docker image size

Tag summary

Content type

Image

Digest

sha256:a68a9101f…

Size

329.3 MB

Last updated

8 months ago

docker pull myanesp/telegram-immich-bot