From a957b047b8a5cf458016afd470cda72804a3a8b5 Mon Sep 17 00:00:00 2001 From: zarazaex69 Date: Mon, 25 May 2026 05:00:53 +0300 Subject: [PATCH] docs: improve docker.md formatting and fix typos --- docs/docker.md | 74 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 54 insertions(+), 20 deletions(-) diff --git a/docs/docker.md b/docs/docker.md index f92f6e6..d6b41e2 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,3 +1,13 @@ +
+ + + +![License](https://img.shields.io/badge/license-WTFPL-0D1117?style=flat-square&logo=open-source-initiative&logoColor=green&labelColor=0D1117) +![Golang](https://img.shields.io/badge/-Golang-0D1117?style=flat-square&logo=go&logoColor=00A7D0) + +
+ + # Локальная настройка 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)