-
Notifications
You must be signed in to change notification settings - Fork 66
/
example.env
383 lines (289 loc) · 24.6 KB
/
example.env
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# ***********************************************************
# Режимы сборки и развертывания
# ***********************************************************
# DocHub может работать в трех режимах:
# (F) frontend - "Толстый" клиент. Вся бизнес-логика находится на стороне фронта.
# (FB) frontend + backend - "Тонкий" клиент. Бизнес-логика в основном находится на стороне backend.
# (P) IDEA Plugin - Плагин для IDEA. Бизнес-логика в основном находится на стороне плагина.
# ***********************************************************
# Переменные среды
# ***********************************************************
# (F / FB) URI в формате DocHub корневого манифеста (обязательно)
# VUE_APP_DOCHUB_ROOT_MANIFEST = workspace/sberauto/root.yaml
# Варианты использования:
# documentation/root.yaml - (F / FB) Относительная ссылка на файл расположенный в папке @/public/
# https://dochub.info/documentation/root.yaml - (F / FB) прямая ссылка на внешний http/https ресурс
# gitlab:34:[email protected] - Прямая ссылка на на файл в GitLab репозитории.
# (F) Может использоваться только при указании VUE_APP_DOCHUB_PERSONAL_TOKEN или VUE_APP_DOCHUB_GITLAB_URL + VUE_APP_DOCHUB_APP_ID
# (FB) Может использоваться только при указании VUE_APP_DOCHUB_PERSONAL_TOKEN
# Структура ссылки:
# gitlab - протокол GitLab
# 34 - идентификатор репозитория
# main - бранч
# root.yaml - путь к файлу
#
# file://root.yaml - (FB) Прямая ссылка на файл в хранилище VUE_APP_DOCHUB_BACKEND_FILE_STORAGE.
# Если VUE_APP_DOCHUB_BACKEND_FILE_STORAGE не задан, то ./public/*
# bitbucket:myproject:myrepo:[email protected] Прямая ссылка на на файл в BitBucket репозитории.
# (F/FB) Может использоваться только при указании VUE_APP_DOCHUB_PERSONAL_TOKEN
# (F / FB) Идентификатор документа главной страницы (необязательно). По умолчанию dochub_welcome
# VUE_APP_DOCHUB_ROOT_DOCUMENT=dochub_welcome
# (F / FB) URL GitLab (необязательно)
# VUE_APP_DOCHUB_GITLAB_URL=https://foo.space
# с base url слеш на конце обязателен
# VUE_APP_DOCHUB_GITLAB_URL=https://foo.space/baseurl/
# (F / FB) URL BitBucket (необязательно)
# VUE_APP_DOCHUB_BITBUCKET_URL=https://foo.space
# с base url слеш на конце обязателен
# VUE_APP_DOCHUB_BITBUCKET_URL=https://foo.space/baseurl/
# (F / FB) Персональный токен gitlab/bitbucket. Используется для развертывания в backend режиме и для локальной разработки (npm run serve)
# VUE_APP_DOCHUB_PERSONAL_TOKEN=9H...FR
# (FB) Secret для доступа к перезагрузке данных архитектуры
# VUE_APP_DOCHUB_RELOAD_SECRET=9H...FR
# (F) Идентификатор приложения зарегистрированного в GitLab (обязательно, если есть VUE_APP_DOCHUB_GITLAB_URL и нет VUE_APP_DOCHUB_PERSONAL_TOKEN)
# https://docs.gitlab.com/ee/integration/oauth_provider.html
# VUE_APP_DOCHUB_APP_ID=5f3...f0
# (F) Секрет приложения (обязательно, если есть VUE_APP_DOCHUB_GITLAB_URL и нет VUE_APP_DOCHUB_PERSONAL_TOKEN)
# https://docs.gitlab.com/ee/integration/oauth_provider.html
# VUE_APP_DOCHUB_CLIENT_SECRET=1e4...384
# (F / FB) Сервер рендеринга PlantUML (По умолчанию www.plantuml.com/plantuml/svg/)
# При сборке через docker-compose по умолчанию localhost:8079/svg/
# VUE_APP_PLANTUML_SERVER=localhost:8079/svg/
# (F / FB) Метод запроса к серверу рендеринга PlantUML (По умолчанию GET)
# POST - в теле запрос в формате plantuml как есть
# POST_COMPRESSED - аналогично GET сжат zopfli, но не перекодирован в base64
# VUE_APP_PLANTUML_REQUEST_TYPE= GET | POST | POST_COMPRESSED
# (P) Если "plugin" сборка осуществляется для использования в IDEA плагине https://github.com/RabotaRu/DocHubIdeaPlugin
# Для production сборки используйте npm run plugin.
# Данный параметр удобен для разработки в режиме плагина, т.к. подключает моки $PAPI.
# VUE_APP_DOCHUB_MODE=plugin
# (PBF) Отключает "hot reload" в DEV режиме
# VUE_APP_DOCHUB_HOTRELOAD=off
# (BF) Если "backend" сборка осуществляется для работы с backend
# Данный параметр удобен для разработки в режиме backend.
# VUE_APP_DOCHUB_MODE=backend
# (F/BF) Определяет тип кэширования при сборке webpack
# memory - по умолчанию. Кэширование ведется в памяти. Оптимизирует только текущую сборку.
# filesystem - Кэширование ведется в файловой системе. Оптимизирует текущую и последующие сборки. Радикальный эффект заметен на последующих сборках.
# VUE_APP_DOCHUB_BUILDING_CACHE= memory / filesystem
# (BF) Определяет принцип кэширования ответов к Data Lake через backend
# none - не кэшируется (по умолчанию)
# redis - для кеширования используется СУБД Redis (https://redis.io/).
# Конфигурация подключения задается в переменной VUE_APP_DOCHUB_REDIS_URL
# memory - кеширование в памяти. При перезагрузке буде очищаться.
#
# Иное значение рассматривается как относительный путь к папке кеширования. Папка должна существовать!
# В этом случае результат запроса будет сохраняться в файле. При перезагрузке кэш будет сохраняться.
# Для его очистки необходимо самостоятельно очистить папку с кэшем.
# Пример пути:
# VUE_APP_DOCHUB_DATALAKE_CACHE=cache/
# (F / FB) Если "y" подключает в описание документацию DocHub
# VUE_APP_DOCHUB_APPEND_DOCHUB_DOCS= y / n
# (F / FB) Содержит ссылку на базовую метамодель. По умолчанию - /metamodel/root.yaml
# VUE_APP_DOCHUB_METAMODEL = /metamodel/root.yaml
# (F / FB / P) (УСТАРЕЛО с версии 3.0.2) Определяет движок рендеринга (graphviz | smetana | elk). По умолчанию ELK
# VUE_APP_DOCHUB_RENDER_CORE=ELK
# С версии v3.0.2 конфигурирование осуществляется через параметры сущности "contexts" см. документацию
# (F / FB) [КЭШ] Включить/отключить кэширование(NONE | HEAD | GET) - По умолчанию NONE
# VUE_APP_DOCHUB_CACHE=NONE
# (F / FB) [УРОВЕНЬ кэширования] (1 | 2) - По умолчанию 1
# 1 - [low level] кэш сетевых запросов(requests)
# 2 - [high level] full кэш(уровень 1 + манифест)
# VUE_APP_DOCHUB_CACHE_LEVEL=1
# (F) Анализатор запросов JSONata
# Выводит информацию о выполняемых запросах в консоль
# VUE_APP_DOCHUB_JSONATA_ANALYZER= y / n
# (FB) Режим backend
# Если установлено, считается, что DocHub функционирует в режиме frontend + backend.
# По умолчанию DocHub функционирует в режиме "толстый клиент" (F). Т.е. вся бизнес-логика реализуется в frontend.
# VUE_APP_DOCHUB_BACKEND_URL= http://localhost:3030
# (FB) Порт для backend сервера. По умолчанию 3030.
# VUE_APP_DOCHUB_BACKEND_PORT=3030
# (FB) Каталог, где размещаются файлы манифестов
# По умолчанию @/public/
# ВНИМАНИЕ! Размещение файлов в @/public/ будет приводить к их прямой доступности из фронта по URL.
# VUE_APP_DOCHUB_BACKEND_FILE_STORAGE=~/DocHub/storage
# (B) Callback URL уведомления о наличии ошибок при загрузке манифестов
# В случае наличия ошибок при загрузке манифестов URL будет вызван методом GET
# VUE_APP_DOCHUB_BACKEND_EVENT_LOADING_ERRORS_FOUND=http://foo.local/error
# (B) Интеграция с СУБД Redis (https://redis.io/)
# Redis применяется для кэширования результатов запросов на стороне backend, а также для создания кластера DocHub.
# Формат URL подключения: redis[s]://[[username][:password]@][host][:port][/db-number]
# Пример: redis://alice:[email protected]:6380
# По умолчанию значение - redis://localhost:6379
# VUE_APP_DOCHUB_REDIS_URL=redis://localhost:6379
# (B) Кластер DocHub (beta)
# Обеспечивает высокую доступность сервиса. На производительность не влияет.
# Количество нод в кластере условно не ограничено. Для работы кластер требует Redis.
# По умолчанию кластер выключен (off).
# VUE_APP_DOCHUB_CLUSTER= on / off
# ***********************************************************
# Пример конфигурирования ролевой модели
# ***********************************************************
# (B) Режим backend
# Если "y", то включается режим работы с ролевой модель.
# VUE_APP_DOCHUB_ROLES_MODEL= y / n
# Указываем путь до манифеста с описанием ролей
# Пример описания:
# roles:
# users:
# - '^kadzo.v2023.data_objects*$'
# - '^ecogroup.berezka.data_objects[a-zA-Z\._0-9]*$'
# uek:
# - '^kadzo\.v2023\.kb_systems[a-zA-Z\._0-9]*$'
# - '^ecogroup.berezka.kb[a-zA-Z\._0-9]*$'
# default:
# - '^kadzo\.v2023\.data_objects*$'
#VUE_APP_DOCHUB_ROLES=file:///workspace/sberauto/roles.yaml
# Варианты использования:
# documentation/roles.yaml - (F / FB) Относительная ссылка на файл расположенный в папке @/public/
# https://dochub.info/documentation/roles.yaml - (F / FB) прямая ссылка на внешний http/https ресурс
# gitlab:34:[email protected] - Прямая ссылка на на файл в GitLab репозитории.
# (F) Может использоваться только при указании VUE_APP_DOCHUB_PERSONAL_TOKEN или VUE_APP_DOCHUB_GITLAB_URL + VUE_APP_DOCHUB_APP_ID
# (FB) Может использоваться только при указании VUE_APP_DOCHUB_PERSONAL_TOKEN
# Структура ссылки:
# gitlab - протокол GitLab
# 34 - идентификатор репозитория
# main - бранч
# root.yaml - путь к файлу
#
# file://roles.yaml - (FB) Прямая ссылка на файл в хранилище VUE_APP_DOCHUB_BACKEND_FILE_STORAGE.
# Если VUE_APP_DOCHUB_BACKEND_FILE_STORAGE не задан, то ./public/*
# bitbucket:myproject:myrepo:[email protected] Прямая ссылка на на файл в BitBucket репозитории.
# (F/FB) Может использоваться только при указании VUE_APP_DOCHUB_PERSONAL_TOKEN
# Указываем путь до сервера аутентификации с указанием realms
#VUE_APP_DOCHUB_AUTHORITY_SERVER=https://auth.slsdev.ru/realms/dochub
# Указываем client id, например: dochub
#VUE_APP_DOCHUB_AUTHORITY_CLIENT_ID={CLIENTID}
# {PUBLIC KEY} - указываем public key, смотрим настройки keycloack
#VUE_APP_DOCHUB_AUTH_PUBLIC_KEY=-----BEGIN PUBLIC KEY-----{PUBLIC KEY}-----END PUBLIC KEY-----
# (FB) Включение поддержки HTML тэгов в markdown документах
# По умолчанию поддержка выключена (off).
# VUE_APP_DOCHUB_MARKDOWN_HTML= on / off
# ***********************************************************
# Примеры конфигурирования
# ***********************************************************
# (F)******** Портал с документацией DocHub *****************
# Развертывание в режиме frontend (толстый клиент)
# содержимое файла .env - ПУСТО.
# Команда сборки:
# npm run build
# Результат:
# - В папке ./dist будет сгенерированы статические файлы, которые нужно подключить к WEB серверу
# - Войдя на портал, пользователь увидит только документацию DocHub.
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# (F)******** Портал с собственной документацией *****************
# Развертывание в режиме frontend (толстый клиент)
# содержимое файла .env:
# VUE_APP_PLANTUML_SERVER=https://plantuml.local/svg/
# VUE_APP_DOCHUB_ROOT_MANIFEST=workspace/sberauto/root.yaml
# Команда сборки:
# npm run build
# Результат:
# - В папке ./dist будет сгенерированы статические файлы, которые нужно подключить к WEB серверу
# - Войдя на портал, пользователь увидит документацию DocHub
# - Войдя на портал, пользователь увидит документацию размещенную по пути ./public/workspace/sberauto/*
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием собственного сервера https://plantuml.local/svg/ (требуется развернуть).
# (F)* Портал с собственной документацией и без документации DocHub **
# Развертывание в режиме frontend (толстый клиент)
# содержимое файла .env:
# VUE_APP_DOCHUB_ROOT_MANIFEST=workspace/sberauto/root.yaml
# VUE_APP_DOCHUB_APPEND_DOCHUB_DOCS=n
# Команда сборки:
# npm run build
# Результат:
# - В папке ./dist будет сгенерированы статические файлы, которые нужно подключить к WEB серверу
# - Войдя на портал, пользователь увидит документацию размещенную по пути ./public/workspace/sberauto/*
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# (F)* Портал с собственной документацией из GitLab без авторизации **
# Развертывание в режиме frontend (толстый клиент)
# содержимое файла .env:
# VUE_APP_DOCHUB_GITLAB_URL=https://gitlab.com/
# VUE_APP_DOCHUB_ROOT_MANIFEST=gitlab:43847396:[email protected]
# VUE_APP_DOCHUB_PERSONAL_TOKEN=gl...4g
# VUE_APP_PLANTUML_SERVER=https://plantuml.local/svg/
# Команда сборки:
# npm run build
# Результат:
# - В папке ./dist будет сгенерированы статические файлы, которые нужно подключить к WEB серверу
# - Войдя на портал, пользователь увидит документацию размещенную по в репозитории GitLab - gitlab:43847396:[email protected]
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием собственного сервера https://plantuml.local/svg/ (требуется развернуть).
# (F)* Портал с собственной документацией из GitLab с авторизацией **
# Развертывание в режиме frontend (толстый клиент)
# содержимое файла .env:
# VUE_APP_DOCHUB_GITLAB_URL=https://gitlab.com/
# VUE_APP_DOCHUB_ROOT_MANIFEST=gitlab:43847396:[email protected]
# VUE_APP_DOCHUB_APP_ID=a00...27f
# VUE_APP_DOCHUB_CLIENT_SECRET=5d8...372
# Команда сборки:
# npm run build
# Результат:
# - В папке ./dist будет сгенерированы статические файлы, которые нужно подключить к WEB серверу
# - Войдя на портал, пользователь будет перенаправлен на авторизацию GitLab
# - После авторизации пользователь увидит документацию размещенную по в репозитории GitLab - gitlab:43847396:[email protected]
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# (FB)******** Портал с документацией DocHub и backend *****************
# Развертывание в режиме frontend + backend (тонкий клиент)
# содержимое файла .env - ПУСТО
# Команда сборки:
# npm run backend
# Результат:
# - Будет собран frontend проект в режиме backend
# - Будет запущен nodejs сервер на порту 3030 (http://localhost:3030/), где будет поднят портал и backend сервер
# - Войдя на портал, пользователь увидит только документацию DocHub.
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# (FB)* Портал с собственной документацией и backend, без документации DocHub**
# Развертывание в режиме frontend + backend (тонкий клиент)
# содержимое файла .env:
# VUE_APP_DOCHUB_ROOT_MANIFEST=workspace/sberauto/root.yaml
# VUE_APP_DOCHUB_APPEND_DOCHUB_DOCS=n
# Команда сборки:
# npm run backend
# Результат:
# - Будет собран frontend проект в режиме backend
# - Будет запущен nodejs сервер на порту 3030 (http://localhost:3030/), где будет поднят портал и backend сервер
# - Войдя на портал, пользователь увидит документацию размещенную по пути ./public/workspace/sberauto/*
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# (FB) Портал с собственной документацией и backend, без документации DocHub, с кешированием в Redis
# Развертывание в режиме frontend + backend (тонкий клиент) + Redis
# содержимое файла .env:
# VUE_APP_DOCHUB_ROOT_MANIFEST=workspace/sberauto/root.yaml
# VUE_APP_DOCHUB_APPEND_DOCHUB_DOCS=n
# VUE_APP_DOCHUB_DATALAKE_CACHE=redis
# VUE_APP_DOCHUB_REDIS_URL=redis://alice:[email protected]:6380
# Команда сборки:
# npm run backend
# Результат:
# - Будет собран frontend проект в режиме backend
# - Будет запущен nodejs сервер на порту 3030 (http://localhost:3030/), где будет поднят портал и backend сервер
# - Войдя на портал, пользователь увидит документацию размещенную по пути ./public/workspace/sberauto/*
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# - Результаты запросов будут кэшироваться в Redis, что увеличит производительность
# (FB) Портал с собственной документацией в кластере, без документации DocHub, с кешированием в Redis
# Развертывание в режиме frontend + backend (тонкий клиент) + Redis + Cluster
# Для работы кластера необходимо самостоятельно развернуть балансировщик запросов.
# Например на nginx - https://nginx.org/ru/docs/http/ngx_http_upstream_module.html
# Недоступная нода определяется по коду ответа - 503.
#
# Конфигурация идентична для всех нод. Содержимое файла .env:
## Доступ к ресурсам с манифестами должен быть у всех нод кластера
# VUE_APP_DOCHUB_ROOT_MANIFEST=workspace/sberauto/root.yaml
# VUE_APP_DOCHUB_APPEND_DOCHUB_DOCS=n
# VUE_APP_DOCHUB_DATALAKE_CACHE=redis
# VUE_APP_DOCHUB_REDIS_URL=redis://alice:[email protected]:6380
# VUE_APP_DOCHUB_CLUSTER=on
# VUE_APP_DOCHUB_BACKEND_PORT=3030
## Вызов бэкенда должен происходить через балансировщик, который перенаправляет запросы на действующую ноду.
# VUE_APP_DOCHUB_BACKEND_URL=http://node-balancer:3030
# Команда сборки:
# npm run backend
# Результат:
# - Будет собран frontend проект в режиме backend
# - Будет запущена нода кластера на порту 3030 (http://localhost:3030/), где будет поднят портал backend сервер
# - Войдя на портал, пользователь увидит документацию размещенную по пути ./public/workspace/sberauto/*
# - Рендеринг PlantUML диаграмм будет осуществляться с использованием публичного сервера с ограничением размера контента.
# - Результаты запросов будут кэшироваться в Redis, что увеличит производительность
# - Запросы к backend будут направляться на балансировщик, который перенаправит их на действующую ноду
# - Ноды backend будут работать в кластере, что увеличит надежность
# Больше информации о переменных среды выполнения
# https://cli.vuejs.org/ru/guide/mode-and-env.html