diff --git a/docker-compose-debug.yaml b/docker-compose-debug.yaml index fcbd801..ada6e48 100644 --- a/docker-compose-debug.yaml +++ b/docker-compose-debug.yaml @@ -1,3 +1,5 @@ +# Конфигурация, удобная для разработки в PyCharm: бот запускается без docker, порты postgres и redis открыты на localhost +# Не используйте её в production! version: '3' services: postgres: diff --git a/docker-compose-full.yaml b/docker-compose-full.yaml index e3988fa..eb9bc57 100644 --- a/docker-compose-full.yaml +++ b/docker-compose-full.yaml @@ -1,3 +1,4 @@ +# Пример сложной конфигурации сервера: реверс-прокси, автоматическое обновление github version: '3' services: postgres: diff --git a/docker-compose-src.yaml b/docker-compose-src.yaml new file mode 100644 index 0000000..2d36328 --- /dev/null +++ b/docker-compose-src.yaml @@ -0,0 +1,36 @@ +# Минимальная конфигурация сервера, код собирается из текущей директории +version: '3' +services: + postgres: + image: postgres + restart: unless-stopped + env_file: + - .env + volumes: + - database:/var/lib/postgresql/data + redis: + image: 'bitnami/redis:latest' + restart: unless-stopped + environment: + - ALLOW_EMPTY_PASSWORD=yes + volumes: + - redis-db:/bitnami/redis/data + env_file: + - .env + olgram: + build: . + restart: unless-stopped + env_file: + - .env + volumes: + - olgram-cert:/cert + ports: + - "${WEBHOOK_PORT}:80" + depends_on: + - postgres + - redis + +volumes: + database: + redis-db: + olgram-cert: diff --git a/docker-compose.yaml b/docker-compose.yaml index 47b17ff..545c544 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,3 +1,4 @@ +# Минимальная конфигурация сервера version: '3' services: postgres: diff --git a/docs/source/developer.rst b/docs/source/developer.rst index da5f9ed..28cc708 100644 --- a/docs/source/developer.rst +++ b/docs/source/developer.rst @@ -1,6 +1,7 @@ Для разработчиков ================= +.. _run: Сборка и запуск --------------- Вы можете развернуть Olgram на своём сервере. Вам потребуется собственный VPS или любой хост со статическим адресом @@ -28,6 +29,24 @@ Не потеряйте TOKEN_ENCRYPTION_KEY! Его нельзя восстановить. В случае утери TOKEN_ENCRYPTION_KEY вы потеряете токены всех ботов, которые пользователи зарегистрировали в вашем боте. +Возможно, вы захотите внести изменения в проект и запустить бот с этими изменениями. Тогда: + +1. Склонируйте репозиторий + +.. code-block:: console + + (bash) $ git clone https://github.com/civsocit/olgram + +2. Внесите в код все изменения, которые хотите внести + +3. В каталоге с репозиторием (рядом с файлами .yaml) создайте файл .env и заполните его, как в инструкции выше + +4. Соберите и запустите сервер: + +.. code-block:: console + + (bash) $ sudo docker-compose -f docker-compose-src.yaml up -d + Дополнительно -------------