https://github.com/lixelv/aiogram-docker-template

Docker compose template for aiogram bot (default echo bot), with postgres database.
https://github.com/lixelv/aiogram-docker-template

aiogram docker docker-compose github-actions postgresql telegram-bot

Last synced: 2 months ago
JSON representation

Docker compose template for aiogram bot (default echo bot), with postgres database.

• Host: GitHub
• URL: https://github.com/lixelv/aiogram-docker-template
• Owner: lixelv
• Created: 2025-01-30T16:58:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-09T21:58:22.000Z (over 1 year ago)
• Last Synced: 2025-02-15T01:29:27.179Z (over 1 year ago)
• Topics: aiogram, docker, docker-compose, github-actions, postgresql, telegram-bot
• Language: Python
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Aiogram Docker Template

A production-ready template for telegram bots using Aiogram 3.x and docker compose for auto deployment by GitHub Actions. By default, this is echo bot with `/help` command to get user's data from database. Also you need to create self-hosted runner for GitHub Actions, there your bot will be deployed. For that you will need your own server.

## Features

-   Built with Aiogram 3.x

-   PostgreSQL database integration

-   Docker compose containerization

-   Multiple deployment modes

-   GitHub Actions CI/CD

-   Environment variables configuration

## Deployment Modes

The template supports three deployment modes:

1. **Local Mode** (`DEPLOY_MODE="prod"`)

    - Creates a new PostgreSQL container

    - Perfect for fast deploy and testing

    - Includes database persistence

2. **Development Mode** (`DEPLOY_MODE="dev"`)

    - Similar to local mode but optimized for development

    - Includes hot-reload capabilities

    - Best for active development

## Setup

1. Create new repository from existing template

2. Setup local hosted runner for GitHub Actions:

    - Goto https://github.com/your_username/your_repo/settings/actions/runners/new?arch=x64&os=linux (change `your_username` on your github username and `your_repo` on repo_name, created from this template)

    - Create new local runner on your server

    - Instead of running `./run.sh` file install github runner as service, here is code are:

        ```bash

        sudo ./svc.sh install

        sudo ./svc.sh start

        ```

    - Download docker and docker compose if they are not installed,:

        ```bash

        sudo curl -fsSL https://get.docker.com | sh

        sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

        sudo chmod +x /usr/local/bin/docker-compose

        ```

3. Create environment for your bot:

    - Goto https://github.com/your_username/your_repo/settings/environments/new (change `your_username` on your github username and `your_repo` on repo_name, created from this template)

    - In name write `production` and continue

    - In environment secrets write:

        - `TELEGRAM_BOT_TOKEN`: Your bot token, get it from [@BotFather](https://t.me/BotFather)

        - `LOGFIRE_TOKEN`: Optional, adding web logging on logfire, get it here: https://logfire.pydantic.dev/

        - `POSTGRES_HOST`: Postgres host, set here `db` or delete postgres service if you need non local postgres

        - `POSTGRES_PORT`: 5432 by default, but if you already have postgres container you can set it to `5433`

        - `POSTGRES_USER`: User for postgres database

        - `POSTGRES_PASSWORD`: Password for postgres database

        - `POSTGRES_DB`: Database name

        - `REDIS_HOST`: Redis host set here `redis`, or delete redis service if you need non local redis

        - `REDIS_PORT`: 6379 by default, but if you already have redis container you can set it to `6380`

        - `REDIS_PASSWORD`: Password for redis

        - `DEPLOY_MODE`: `prod` or `dev`

    - All variables are required (except LOGFIRE_TOKEN)!

5. Develop your bot:

    - Firstly edit `.env.example` file and rename it to `.env`

    - Run `docker-compose -f docker/docker-compose.dev.yaml --env-file .env up --build`

    - Goto `-dev` container and open bot logs below

    - Develop your bot

6. Deploy your bot:

    - Goto https://github.com/your_username/your_repo/actions/workflows/deploy.yml (change `your_username` on your github username and `your_repo` on repo_name, created from this template)

    - Press Run workflow and start your bot! This workflow will be triggered any time you push any code to `main`.

## Setting new environment variables

1. Create a new secret in `production` environment, in our case this will be `VARIABLE_NAME`.

2. Change `deploy.yml` file, add `echo "VARIABLE_NAME=\"${{ secrets.VARIABLE_NAME }}\"" >> .env` line

3. After you can get your variable value in python using `os.getenv("VARIABLE_NAME")`