From 6717f93f8eb6e6302468d98f28f62267000b5f8c Mon Sep 17 00:00:00 2001 From: Dmitrii Makarkin Date: Thu, 7 Nov 2024 00:27:31 +0300 Subject: [PATCH] feat(docs): updated description --- .changeset/two-poets-watch.md | 21 +++++++++++++++++++++ packages/arui-scripts/docs/overrides.md | 3 +++ packages/arui-scripts/docs/settings.md | 17 +++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 .changeset/two-poets-watch.md diff --git a/.changeset/two-poets-watch.md b/.changeset/two-poets-watch.md new file mode 100644 index 00000000..9426d651 --- /dev/null +++ b/.changeset/two-poets-watch.md @@ -0,0 +1,21 @@ +--- +'arui-scripts': minor +--- + +#### Добавлена возможность перезаписывать некоторые параметры для базового конфига nginx (/etc/nginx/nginx.conf). + +Пример добавления нового свойства `nginx` (в примере указаны значения, которые и так будут использованы по-умолчанию) + +```json +"aruiScripts": { + "nginx": { + "workerProcesses": 2, + "workerRlimitNoFile": 20000, + "workerConnections": 19000, + "eventsUse": "epoll", + "daemon": "off" + } +} +``` + + diff --git a/packages/arui-scripts/docs/overrides.md b/packages/arui-scripts/docs/overrides.md index 5c80dc06..22eb56d9 100644 --- a/packages/arui-scripts/docs/overrides.md +++ b/packages/arui-scripts/docs/overrides.md @@ -69,6 +69,9 @@ export default overrides; - `nginx` - шаблон конфигурации для nginx внутри контейнера. Базовый шаблон [тут](../src/templates/nginx.conf.template.ts). [Файл `nginx.conf`](nginx.md) в корне имеет приоритет над оверрайдами. +- `nginxConf` - шаблон базовой конфигурации для nginx внутри контейнера + Базовый шаблон аналогичный тому, который добавлется в базовый образ [тут](../src/templates/base-nginx.conf.template.ts). + [Файл `base-nginx.conf`](base-nginx.md) в корне имеет приоритет над оверрайдами. - `start.sh` - шаблон entrypoint докер контейнера. Базовый шаблон [тут](../src/templates/start.template.ts). - `serverExternalsExemptions` - список модулей, которые не будут добавлены в список внешних зависимостей сервера. [Подробнее](caveats.md#node-externals). - `html` - шаблон для htmlWebpackPlugin, будет использоваться только в режиме [`clientOnly`](./settings.md#clientonly). diff --git a/packages/arui-scripts/docs/settings.md b/packages/arui-scripts/docs/settings.md index efb4cad6..a777a451 100644 --- a/packages/arui-scripts/docs/settings.md +++ b/packages/arui-scripts/docs/settings.md @@ -173,6 +173,23 @@ const settings = { #### nginxRootPath Базовый путь, до файлов в контейнере, который будет использоваться в nginx. По умолчанию `'/src'`. +#### nginx + +Некоторые настройки для базовой конфигурации `nginx` (`/etc/nginx/nginx.conf`). +До этого их нельзя было перезаписать обычными overrides. + +```json +"aruiScripts": { + "nginx": { + "workerProcesses": 2, + "workerRlimitNoFile": 20000, + "workerConnections": 19000, + "eventsUse": "epoll", + "daemon": "off" + } +} +``` + #### runFromNonRootUser Сборка образа под пользователем nginx. Нужна для совместимости с k8s, т.к там зачастую запрещен запуск контейнера из под root По умолчанию `true`.