mirror of
https://github.com/openlibrecommunity/olcrtc.git
synced 2026-05-31 17:39:44 +00:00
docs: improve docker.md formatting and fix typos
This commit is contained in:
zarazaex69
@@ -1,3 +1,13 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="https://github.com/openlibrecommunity/material/blob/master/olcrtc.png" width="250" height="250">
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
# Локальная настройка Docker
|
||||
|
||||
Здесь описан один из способов запуска сервера olcrtc с локальной конфигурацией Docker.
|
||||
@@ -8,22 +18,28 @@
|
||||
- хранить конфигурационные файлы вне Git, в папке `.local`
|
||||
- позволять пользователям обновлять репозиторий обычным `git pull`
|
||||
|
||||
## 1. Клонирование репозитория
|
||||
---
|
||||
|
||||
## Шаг 1: Клонирование репозитория
|
||||
|
||||
```bash
|
||||
git clone https://github.com/openlibrecommunity/olcrtc.git
|
||||
cd olcrtc
|
||||
```
|
||||
|
||||
## 2. Обновление до последней версии
|
||||
---
|
||||
|
||||
Чтобы получить новую версию из upstream, выполните команду ниже:
|
||||
## Шаг 2: Обновление до последней версии
|
||||
|
||||
Чтобы получить новую версию из upstream:
|
||||
|
||||
```bash
|
||||
git pull https://github.com/openlibrecommunity/olcrtc.git -recurse-submodules
|
||||
git pull https://github.com/openlibrecommunity/olcrtc.git --recurse-submodules
|
||||
```
|
||||
|
||||
## 3. Папка для локальных конфигураций
|
||||
---
|
||||
|
||||
## Шаг 3: Папка для локальных конфигураций
|
||||
|
||||
Создайте директорию `.local` в корне репозитория:
|
||||
|
||||
@@ -31,27 +47,33 @@ git pull https://github.com/openlibrecommunity/olcrtc.git -recurse-submodules
|
||||
mkdir -p .local
|
||||
```
|
||||
|
||||
Эта папка должна содержать файлы, которые будут использоваться только на вашей сервере.
|
||||
Эта папка должна содержать файлы, которые будут использоваться только на вашем сервере.
|
||||
|
||||
## 4. Скопируйте docker-compose.yml в `.local`
|
||||
---
|
||||
|
||||
Скопируйте файл ``docker-compose.yml`` (есть в репозитории), чтобы ваша локальная версия не перезаписывалась при следующем обноволении репозитория через ``git pull``:
|
||||
## Шаг 4: Скопируйте docker-compose.yml в `.local`
|
||||
|
||||
Скопируйте файл `docker-compose.server.yml`, чтобы ваша локальная версия не перезаписывалась при следующем обновлении репозитория через `git pull`:
|
||||
|
||||
```bash
|
||||
cp docker-compose.server.yml .local/docker-compose.server.yml
|
||||
```
|
||||
|
||||
Если файл `docker-compose.yml` позже изменится, скопируйте его снова этой же командой после `git pull`.
|
||||
Если файл `docker-compose.server.yml` позже изменится, скопируйте его снова этой же командой после `git pull`.
|
||||
|
||||
## 5. Создайте локальный файл окружения
|
||||
---
|
||||
|
||||
Создайте `.local/.env` и заполните значения выполнения в соответствии с выбранным типом подключения.
|
||||
## Шаг 5: Создайте локальный файл окружения
|
||||
|
||||
Создайте `.local/.env` и заполните значения в соответствии с выбранным типом подключения.
|
||||
|
||||
Пример можно найти в `docs/examples/.env.telemost.server.example`.
|
||||
|
||||
## 6. Запуск OLCRTC
|
||||
---
|
||||
|
||||
Запуск контейнеризированного сервера используя ``docker-compose.server.yml`` и локальный ``.env``:
|
||||
## Шаг 6: Запуск OLCRTC
|
||||
|
||||
Запуск контейнеризированного сервера используя `docker-compose.server.yml` и локальный `.env`:
|
||||
|
||||
```bash
|
||||
docker compose -f .local/docker-compose.server.yml --env-file .local/.env up -d
|
||||
@@ -63,16 +85,18 @@ docker compose -f .local/docker-compose.server.yml --env-file .local/.env up -d
|
||||
docker compose -f .local/docker-compose.server.yml --env-file .local/.env ps
|
||||
```
|
||||
|
||||
Просмотр логов контейнера:
|
||||
Просмотр логов контейнера:
|
||||
|
||||
```bash
|
||||
docker compose -f .local/docker-compose.server.yml --env-file .local/.env logs -f
|
||||
docker logs olcrtc-server
|
||||
```
|
||||
|
||||
## 7. Обновление контейнера
|
||||
---
|
||||
|
||||
Запустить команду ниже для получения новой версии репозитория из облака:
|
||||
## Шаг 7: Обновление контейнера
|
||||
|
||||
Получите новую версию репозитория:
|
||||
|
||||
```bash
|
||||
git pull https://github.com/openlibrecommunity/olcrtc.git
|
||||
@@ -81,24 +105,34 @@ git pull https://github.com/openlibrecommunity/olcrtc.git
|
||||
После каждого обновления сравните новый и старый файл:
|
||||
|
||||
```bash
|
||||
diff -wy .local/docker-compose.yml docker-compose.server.yml
|
||||
diff -wy .local/docker-compose.server.yml docker-compose.server.yml
|
||||
```
|
||||
|
||||
Если есть отличия скопируйте файл из корня в папку ``.local``:
|
||||
Если есть отличия, скопируйте файл из корня в папку `.local`:
|
||||
|
||||
```bash
|
||||
cp docker-compose.server.yml .local/docker-compose.server.yml
|
||||
```
|
||||
|
||||
Затем перезапустите контейнер командами ниже:
|
||||
Затем перезапустите контейнер:
|
||||
|
||||
```bash
|
||||
docker compose -f .local/docker-compose.server.yml down
|
||||
docker compose -f .local/docker-compose.server.yml --env-file .local/.env up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Примечания
|
||||
|
||||
- Храните все локальные Docker-файлы внутри отдельной папки `.local`.
|
||||
- Не добавляйте `.local` в репозиторий (она должна быть в файле ``.gitignore``)
|
||||
- Не добавляйте `.local` в репозиторий (она должна быть в `.gitignore`).
|
||||
- Держите общую документацию в `docs/`, а специфичные настройки в `.local`.
|
||||
|
||||
---
|
||||
|
||||
Используешь скрипты вместо Docker? -> [Быстрый старт](fast.md)
|
||||
|
||||
Хочешь собрать руками без контейнеров? -> [Мануальная сборка](manual.md)
|
||||
|
||||
Все настройки и матрица совместимости -> [settings.md](settings.md)
|
||||
|
||||
Reference in New Issue
Block a user