Borofone_chat | Here readme lol ( ͡° ͜ʖ ͡°)

A simple chat implemented within: FastApi, Redis, Postgres, Docker and SQLAlchemy.

!! Setup

1. Установить зависимости

pip install -r requirements.txt

2. Поднять бд и редис

docker compose -f docker-compose.infra.yml up -d

3. Применить миграции

alembic upgrade head

!! Ожидается 001_baseline (head) !! | 10.02 snapshot

alembic current

4. Запустить приложение

uvicorn app.main:app --reload

run with venv!

.\scripts\start_https.bat

5. Подготовка данные

• Зарегистрировать инвайт-код в БД

• Создать комнату

• При необходимости выдать пользователю права: role -> admin

• При проблемах с uploads - создать директорию /uploads/avatars

Project structure

borofone_chat/
├── app/                        
│   ├── api/                   
│   │   ├── http.py             # REST API handlers (Request processing).
│   │   └── ws.py               # WebSocket and connection management logic
│   ├── infra/                  
│   │   ├── db.py               # SQLAlchemy database configuration (Async)
│   │   └── redis.py            # Redis configuration and client
│   ├── schemas/
│   │   └── *.py                # Pydantic scheme for validating a specific section
│   ├── services/
│   │   └── messages.py         # Logic for sending messages and CRUD operations
│   ├── __init__.py    
│   ├── main.py                 # Entry Point: Initializing FastAPI and Routing
│   ├── models.py               # SQLAlchemy models (database schema)
│   ├── settings.py             # Managing settings via Pydantic Settings
├── .env.production.example     
├── .env.staging.example        
├── docker-compose.yml          # Full environment (API + DB + Redis), not tested!
├── docker-compose.infra.yml    # Local infrastructure (DB + Redis)
├── requirements.txt            
└── README.md                  

// Main components

api/ - contains the logic of interaction with the client.

ws.py implements ConnectionManager, which isolates the message sending logic from the WebSocket protocol.

infra/ - is responsible for the technical details of connecting to external resources.

This is where you configure the asynchronous database engine and connection pool settings.

services/messages.py - functions for working with data. This is where the message processing logic is implemented (for example, checking for duplicates and saving to the database).

docker-compose.infra.yml — development config that allows you to run only the PostgreSQL database and Radis cache in containers, leaving the API itself on the host machine for easy debugging.

Usefull commands

You'll definitely find this useful, I'd think about it. :3

// Docker & Infrastructure

Check docker health:

docker compose -f docker-compose.infra.yml ps

UP infra:

docker compose -f docker-compose.infra.yml up -d

DOWN infra:

docker compose -f docker-compose.infra.yml down

Enter in psql:

docker compose -f docker-compose.infra.yml exec postgres psql -U app -d app

// Application

Start api:

uvicorn app.main:app --reload --port 8000

// SQL Debug Queries

Select Rooms:

SELECT id, title FROM rooms ORDER BY id DESC LIMIT 150;

Select Messages:

SELECT id, room_id, author, body, nonce, created_at FROM messages ORDER BY id DESC LIMIT 50;

Clear all DB (safety):

TRUNCATE TABLE messages, rooms RESTART IDENTITY CASCADE;

// Alembic migration

Current migration version:

alembic current

Create new version migration:

alembic revision --autogenerate -m "sample_text"

Upgrade to new migration version:

alembic upgrade head

Downgrade to 1 step down migration version:

alembic downgrade -1

View migration history:

alembic history --verbose

View the following migrations to apply:

alembic heads

TODO

• Logout in settings
• User was connected to room
• Голосовой чат
• ctrl+v вложения
• Кастомные уведомления
• Реакции
• Реплай
• Маркдаун в сообщениях
• Кастомные темы
• Фавикон
• Пофиксить отображение аватарок в чате
• Закругление углов у картинок
• Исправить отображение онлайн пользователей
• Исправить дизайн панель войсчата
• Статус оффлайн
• Глобальное удаление сообщений
• Нормальный шумодав для войсчата
• Нью смайлы
• Amoled тема
• Демонстрация экрана
• Лимиты на сообщения
• Исправить баг с отправлением вложений, спам много-за-раз
• Верстка для телефона
• Интеграция с гиффи для гифок, дискорд ah
• Добавить Wordle
• Отображение аватарок в войсчате
• Бинд для мута
• Пофиксить разлогин при долгой сессии на сайте
• Исправить отображение онлайн пользователей

🔐 HTTPS для Radmin VPN (Voice Chat)

Для работы голосового чата через Radmin VPN требуется HTTPS, так как getUserMedia() работает только в защищённом контексте.

Шаг 1: Генерация SSL сертификата

Открой PowerShell от имени администратора:

.\scripts\generate_ssl.ps1

Скрипт создаст:

• ssl/voice.pfx - PFX сертификат
• ssl/cert.pem - Сертификат в PEM формате
• ssl/key.pem - Приватный ключ (требуется OpenSSL)
• ssl/cert.crt - Публичный сертификат для друзей

Шаг 2: Запуск HTTPS сервера

# Требуется запуск от имени администратора (порт 443)
python run_https.py

Или с кастомными параметрами:

python run_https.py --host 0.0.0.0 --port 443 --cert ssl/cert.pem --key ssl/key.pem

Шаг 3: Настройка для друзей

Друзьям нужно добавить сертификат в доверенные:

Windows:

1. Открыть ssl/cert.crt
2. Нажать "Установить сертификат"
3. Выбрать "Локальный компьютер" → "Поместить в следующее хранилище"
4. Выбрать "Доверенные корневые центры сертификации"

Chrome/Edge:

1. На браузере: chrome://settings/certificates
2. Import → выбрать cert.crt
3. Выбрать "Trusted Root Certification Authorities"

Шаг 4: Подключение

Друзья заходят по адресу:

https://<RADMIN_IP>/

⚠️ Важно: IP-адрес Radmin VPN может меняться. Обнови .env:

RADMIN_IP=твой_новый_ip

Альтернатива: mkcert (рекомендуется)

Если установлен mkcert:

mkcert -install
mkcert "yourip" localhost

Это создаст сертификаты, которые будут автоматически доверяться браузером.

maybe next time

for vps

git pull origin main docker-compose -f docker-compose.prod.yml build --no-cache api docker-compose -f docker-compose.prod.yml down docker-compose -f docker-compose.prod.yml up -d

Sources

Gitbook: https://qqracha.gitbook.io/qqracha-docs/vKWuRLooKQWdYTCfU3pv

CI/CD

Проект настроен под раздельные staging и production окружения:

main -> production
dev  -> staging

Основные артефакты:

• .github/workflows/deploy.yml - автодеплой по push в dev и main
• .env.production.example и .env.staging.example - шаблоны окружений
• deploy/systemd/ - systemd unit-файлы
• deploy/nginx/borofone.conf - reverse proxy для production и staging
• scripts/setup_vps.sh - первичная подготовка VPS
• docs/deployment/cicd.md - пошаговые инструкции по setup и security

Быстрый сценарий:

push dev       -> GitHub Actions -> staging deploy
merge dev main -> GitHub Actions -> production deploy

Перед включением схемы:

1. Добавь GitHub Secrets для PROD_* и STAGING_*.
2. Используй только .env.production.example и .env.staging.example, затем скопируй их в /opt/borofone-chat-prod/.env и /opt/borofone-chat-staging/.env.
3. Установи deploy/systemd/*.service и deploy/nginx/borofone.conf на VPS.
4. Включи branch protection для main, запрети прямой push и оставь deploy только через PR.

Подробная инструкция: docs/deployment/cicd.md.