Merge pull request 'Update loop to 10.6.0 (main)' (#2) from release/10.6.0 into main

Reviewed-on: #2
Reviewed-by: Stuart Armstrong <stuart.armstrong@wilix.team>
Reviewed-by: Кирилл Моос <kirill.moos@wilix.team>

README.md

@@ -1,4 +1,78 @@
-# Project Deployment
+# Docker‑Compose для Loop‑сервера
+
+## Обзор
+
+В этом репозитории содержатся файлы конфигурации Docker Compose и файлы для развёртывания сервера Loop.
+
+## Быстрый старт
+
+### 1. Клонируйте репозиторий
+```bash
+git clone https://git.wilix.dev/wilix-infra/loop-onprem-docker.git
+cd loop-onprem-docker
+```
+
+### 2. Настройка окружения
+```bash
+cp .env.example .env
+```
+Отредактируйте файл `.env`, указав нужные значения конфигурации.
+
+### 3. Настройка окружения Loop‑сервера
+
+Проверьте и при необходимости отредактируйте файл `docker-compose.yml` в соответствии с вашими требованиями к конфигурации. Текущие значения — по умолчанию, они обеспечат работоспособное развёртывание. Некоторые значения будут подставлены при развёртывании из файла `.env`.
+
+### 4. Запуск сервисов
+```bash
+docker-compose up -d
+```
+
+### 5. Проверка развёртывания
+```bash
+docker-compose ps
+docker-compose logs -f [имя_сервиса]
+```
+
+## Полезные команды
+
+| Действие | Команда |
+| --- | --- |
+| Запуск сервисов | `docker-compose up -d` |
+| Остановка сервисов | `docker-compose down` |
+| Просмотр логов | `docker-compose logs -f` |
+| Перезапуск сервисов | `docker-compose restart` |
+
+## Переменные окружения
+
+| Переменная | Описание | Требуется |
+| --- | --- | --- |
+| `SITEURL` | URL Loop‑сервера | Да |
+| `HTTP_PROTOCOL` | `https://` (предпочтительно) или `http://` | Да |
+| `GIPHYSDKKEY` | Ключ GIPHYSDKKEY | Да |
+| `PG_PASSWORD` | Пароль базы данных | Да |
+| `PG_USER` | Пользователь базы данных | Да |
+| `PG_DB_NAME` | Имя базы данных | Да |
+| `MINIO_ROOT_USER` | Пользователь root в MinIO | Да |
+| `MINIO_ROOT_PASSWORD` | Пароль пользователя root в MinIO | Да |
+| `ACCESS_KEY_ID` | Ключ доступа S3 | Да |
+| `SECRET_ACCESS_KEY` | Секретный ключ S3 | Да |
+| `BUCKET_NAME` | Имя бакета S3 | Да |
+
+## SSL‑сертификат для протокола `https://`
+
+Поместите файлы сертификата и ключа в папку `cert`. Имена файлов по умолчанию — `server.crt` и `server.key`. Если имена сертификатов отличаются от значений по умолчанию, обновите файл `loop-ssl.conf` в папке `nginx`.
+
+## Устранение неполадок
+
+* **Просмотр логов сервиса**: `docker-compose logs [имя_сервиса]`
+
+## Лицензия
+
+[Тип лицензии] — подробности см. в файле LICENSE.
+
+#####
+
+# Loop Server Docker Compose
 
 ## Overview
 
@@ -23,12 +97,12 @@ Edit the `.env` file with your specific configuration values.
 Check and edit, if required, the `docker-compose.yml` file for your specific configuration requirements. The current values are default and will ensure a working deployment. Some values will be populated on deployment from the `.env` file.
 
 
-### 3. Start the Services
+### 4. Start the Services
 ```bash
 docker-compose up -d
 ```
 
-### 4. Verify Deployment
+### 5. Verify Deployment
 ```bash
 docker-compose ps
 docker-compose logs -f [service-name]
@@ -59,6 +133,10 @@ docker-compose logs -f [service-name]
 | `SECRET_ACCESS_KEY` | S3 secret key | Yes |
 | `BUCKET_NAME` | S3 bucket name | Yes |
 
+## SSL Cert for https:// protocol
+
+Place the certificate and key files in the `cert` folder, default names should be `server.crt` and `server.key`. Update the `loop-ssl.conf` in the `nginx` folder, if the certificate names are not the default.
+
 ## Troubleshooting
 
 - **View service logs**: `docker-compose logs [service_name]`

cert/README.md

@@ -0,0 +1,4 @@
+### Place TLS certificate and key in this folder.
+
+Defaults:
+`server.crt` and `server.key`

docker-compose.yml

@@ -17,7 +17,7 @@ services:
 
   loop:
     container_name: loop
-    image: "registry.loop.ru/loop/server:10.5.0"
+    image: registry.loop.ru/loop/server:10.6.0
     restart: "unless-stopped"
     depends_on:
       - "db"