diff --git a/README.md b/README.md index 41353cb..c7c79bc 100644 --- a/README.md +++ b/README.md @@ -69,4 +69,78 @@ Place the certificate and key files in the `cert` folder, default names should b ## License -[License type] - See LICENSE file for details. \ No newline at end of file +[License type] - See LICENSE file for details. + +##### + +# 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. \ No newline at end of file