Skip to content

Commit

Permalink
feat(docs): updated description
Browse files Browse the repository at this point in the history
  • Loading branch information
makdv committed Nov 6, 2024
1 parent a37c28c commit 6717f93
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .changeset/two-poets-watch.md
Original file line number Diff line number Diff line change
@@ -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"
}
}
```


3 changes: 3 additions & 0 deletions packages/arui-scripts/docs/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
17 changes: 17 additions & 0 deletions packages/arui-scripts/docs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit 6717f93

Please sign in to comment.