intelligram-bot's Introduction

Intelligram Bot

About The Project

A personal telegram bot application built with python

Installation

Docker Compose

services:
    intelligram-bot:
        image: ghcr.io/klementng/intelligram-bot:latest
        container_name: intelligram-bot
        environment:
            - BOT_TOKEN=
        ports:
            - 88:88
        volumes:
            - /path/to/data:/config
        restart: unless-stopped

Docker Cli

docker create \
  --name=intelligram-bot \
  -e - BOT_TOKEN= \
  --restart unless-stopped \
  ghcr.io/klementng/intelligram-bot:latest

(back to top)

Configuration

Environment Variable	Description	Default Value
BOT_TOKEN	Telegram bot API token (required)	null
BOT_CONFIG_DIR	Working directory for storing configuration & data (optional)	/config
BOT_DB_PATH	Path to SQlite database file (optional)	{BOT_CONFIG_DIR}/data/data.db
BOT_SERVER_HOSTNAME	Hostname or IP for bot (optional)	(current public ip address)
BOT_SERVER_PUBLISHED_PORT	Published for telegram server to send request to. Allowed ports:443, 80, 88 and 8443 (optional)	88
BOT_SERVER_PORT	Internal Server Port (optional)	88
BOT_SERVER_CERT_PATH	Path to signed ssl public cert (optional). Both BOT_SERVER_CERT_PATH & BOT_SERVER_KEY_PATH must be set. Else an self-signed cert & key will be generated using openssl at {BOT_CONFIG_DIR}/ssl/cert.pem & {BOT_CONFIG_DIR}/ssl/key.pem	null
BOT_SERVER_KEY_PATH	see above	null
BOT_SERVER_IS_STANDALONE	Internal Server is a Standalone Server. Set false if using reverse proxy	true
BOT_SERVER_PUBLISHED_URL	Published URL	https://{HOSTNAME}:{PUBLISHED_PORT}

Recommend Projects