Быстрый старт | NLines Easy Docs

Локальный запуск#

Установите Docker с Compose v2.
В корне репозитория поднимите хаб одной командой:

./up.sh

(В PowerShell: .\up.ps1.) Эквивалент:

docker compose --profile prepare run --rm prepare && docker compose up -d

Сервис prepare (профиль prepare) собирает руководство в data/easydocs/guide/, портал в data/portal/public/ (образ peaceiris/hugo:v0.146.4-full). Руководство в каталоге docs/ оформлено темой Hugo Book (git submodule docs/themes/hugo-book). При отсутствии .env копируется .env.example (в примере BASIC_AUTH_ENABLED=false для быстрого старта).

Откройте https://<DOMAIN>/. Для docs.local добавьте запись в hosts или укажите DOMAIN=localhost в .env.
При BASIC_AUTH_ENABLED=true задайте BASIC_AUTH_HASH (см. раздел «Конфигурация»).

Где лежит эта документация#

После сборки Hugo из каталога docs/ статика попадает в data/easydocs/guide/. В хабе она открывается по пути /docs/easydocs/guide/.

Локальная сборка без Compose (абсолютные пути, чтобы вывод не попал в docs/data/):

docker run --rm -v "$(pwd):/src" -w /src peaceiris/hugo:v0.146.4-full \
  --minify -s /src/docs -d /src/data/easydocs/guide --cleanDestinationDir \
  --baseURL /docs/easydocs/guide/
docker run --rm -v "$(pwd):/src" -w /src peaceiris/hugo:v0.146.4-full \
  --minify -s /src/data/portal -d /src/data/portal/public --cleanDestinationDir --baseURL /

Порты за прокси#

Внутри контейнера слушаются 80 и 443. На хосте используйте переменные HTTP_PORT и HTTPS_PORT в .env (см. .env.example). Пример: HTTPS_PORT=9031 — доступ по https://сервер:9031/.