Описание параметров конфигурации приложения

В зависимости от сценария использования содержимое может существенно изменяться.
В данном примере для рассмотрена стандартная тестовая настройка config.json

{
    "install": false,
    "license": "UJxjSQlJ9qH7/K8jqAtsuxG4x6a3XteS9HghhG4DutUEuIv****",
    "hash": "srv-01",
    "hostname": "editboard.mycorp.com",
    "domain": "editboard.mycorp.com",
    "version": "1.10.1",
    "cert": {
        "crt": "/conf/ssl/cert.crt",
        "key": "/conf/ssl/cert.key"
    },
    "type": [
        "api",
        "socket",
        "upload",
        "clickhouse",
        "redis",
        "admin",
        "avp",
        "coordinator",
        "miro",
        "convert_video",
        "convert_documents"
    ],
    "clickhouse": {
        "url": "http://137.139.132.2/",
        "port": 8123,
        "database": "clickhouse",
        "username": "default",
        "password": "DefaultPassword"
    },
    "master_process": 0,
    "priority": 1,
    "split_port": true,
    "mongo_path": "mongodb://editboard_user:dfhdfhcvbxGi@122.50.32.141:27017/editboard",
    "inner_port": 8080,
    "https_port": 443,
    "redis": {
        "host": "127.0.0.1",
        "port": 6379,
        "pass": "vMotn8dZTGddfhdfzcvndDN0tj0********"
    },
    "jwtkey": "testtest",
    "network": "eth0",
    "modules": {
        "test": {
            "whiteboard_api_partner": "test",
            "whiteboard_api_key": "1234567890abcdefgh1234567890abcd"
        },
        "sso": {
            "module_type": "sso",
            "type": "saml",
            "entry_point": "https://adfs.mycorp.com/adfs/ls/",
            "issuer": "https://editboard.mycorp.com/sso/",
            "cert": "/conf/adfsmycorp.cert",
            "callback_url": "https://editboard.mycorp.com/sso/callback",
            "field_id": "http://schemas.xmlsoap.org/claims/EmailAddress",
            "field_name": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
            "exit_url": "https://editboard.mycorp.com",
            "whiteboard_api_partner": "sso",
            "whiteboard_api_key": "sso"
        }
    },
    "recording": {
        "ffmpeg_path": "/usr/bin/ffmpeg",
        "ffmpeg_audio_codec": "aac"
    },
    "s3":{
        "access_key":"YCAJEZZ2WQyqGTL**********",
        "secret_key":"YCPC1C9iW_LJLc7bMvgY9LiCl4O6vC**********",
        "bucket":"s3-editboard",
        "endpoint":"https://storage.yandexcloud.net",
        "public_prefix":"https://storage.yandexcloud.net/s3-editboard/",
        "region":"ru-central1",
        "extensions": [
            "png",
            "jpeg",
            "jpg",
            "pdf",
            "docx",
            "doc",
            "xlsx",
            "xls",
            "pptx",
            "ppt",
            "mp4",
            "mp3"
        ]
    }
}

Значения параметров конфигурации приложения

Примечание

Некоторые секции конфигурации рассмотрены подробнее в соответствующих разделах
SSO - Модуль SSO
Object Storage - Настройка Object Storage

Параметр Описание Тип данных
install Режим установки. Если true, то создается БД, коллекций в ней, а также импорт шаблонов. false — для обычного запуска. Нельзя удалять из конфигурации Логический
license Для хранения лицензионного ключа Строка
hash Хеш имя сервера (например название данного сервера) Строка
hostname Имя хоста на котором работает приложение Строка
domain Доменное имя на котором работает приложение Строка
version Текущая версия приложения Строка
cert Путь до сертификатов cert.crt и cert.key Объект
type Массив с перечнем ролей сервера Массив
master_process Параметр для управления процессами приложения Число
priority Требует настройки, только если сервер имеет роль redis или coordinator Число
split_port Служебный параметр Логический
mongo_path Конфигурация для подключения к MongoDB Строка
clickhouse Настройка подключения к ClickHouse Объект
inner_port Порт для внутреннего трафика приложения Число
https_port Порт для защищенного HTTPS трафика. По нему отправляем запросы к приложению Число
redis Настройки подключения к Redis, включая хост, порт и пароль Объект
jwtkey Ключ для генерации и верификации JWT токенов Строка
network Сетевой интерфейс, который используется приложением Строка
modules Конфигурация модулей приложения. Например test модуль или SSO Объект
recording Настройки для записи медиа, включая путь к ffmpeg и используемый аудиокодек Объект
s3 Конфигурация для подключения к хранилищу S3 Объект
cabinet Путь к основной версии личного кабинета* Объект
dump Настройка свойств резервных копий досок* Объект
logs Настройка свойств логирования действий во внешние системы* Объект
miro Настройка параметров для импорта объектов из Miro* Объект
ldap Управление периодичностью синхронизации по LDAP Объект

Расширенное описание для вложенных секций

Описание секции cert

    "cert": {
        "crt": "/conf/ssl/cert.crt",
        "key": "/conf/ssl/cert.key"
    },
Параметр Описание Тип данных
crt Путь до открытого ключа Строка
key Путь до закрытого ключа Строка

Описание секции type

    "type":[
        "api",
        "socket",
        "upload",
        "clickhouse",
        "redis",
        "admin",
        "avp",
        "coordinator",
        "convert_video",
        "convert_documents",
        "miro"
    ],
Параметр Описание Тип данных
api Фронт сервера. Отвечают за распределение по сокетам Строка
socket WebSocket сервер Строка
upload Сервер, на который загружаем файлы и выгружаем в s3 хранилище Строка
clickhouse Сервер, на который отправляются статистику для агрегации и обработки Строка
redis Устанавливается для одного сервера, через который предполагается обрабатывать запросы от остальных частей приложения. Если несколько серверов, то у каждого должен быть свой priority Строка
coordinator Служит для выполнения единых cron задач (например, автоматическое удаление неактивных пользователей или синхронизации LDAP) Строка
admin Сервер для администрирования приложения, мониторинга и статистики Строка
avp Сервер с установленным антивирусным ПО Строка
convert_video Сервер на котором выполняется обработка видеоматериалов Строка
convert_documents Сервер на котором выполняется обработка документов (pdf и т.д.) Строка
miro Сервер на котором выполняется импорт и обработка досок из Miro Строка

Описание секции redis

    "redis": {
        "host": "127.0.0.1",
        "port": 6379,
        "pass": "vMotn8dZTGddfhdfzcvndDN0tj0********"
    },
Параметр Описание Тип данных
host ip адрес используемого Redis сервера Строка
port Порт работы Redis Число
pass По умолчанию пароль уже настроен в создаваемом автоматически redis.conf. В случае изменения пароля в конфигурационном файле Redis, необходимо изменить его и здесь Строка

Описание секции clickhouse

    "clickhouse": {
        "url": "http://137.139.132.2/",
        "port": 8123,
        "database": "clickhouse",
        "username": "default",
        "password": "DefaultPassword"
    },

Либо

    "clickhouse": {
        "disabled" : true
    },
Параметр Описание Тип данных
url ip адрес используемого ClickHouse сервера Строка
port Порт работы ClickHouse Число
database Название базы к которой выполняется подключение Строка
username Имя пользователя ClickHouse, которое будет использоваться для подключения к базе данных Строка
password Пароль для пользователя, указанного в параметре username Строка
disabled Параметр отвечает за включение или отключение поиска подключения к базе ClickHouse. Если не используется подключение к ClickHouse, установить значение true Строка

Описание секции modules

"modules": {
        "test": {
            "whiteboard_api_partner": "test",
            "whiteboard_api_key": "1234567890abcdefgh1234567890abcd"
        },
        "sso": {
            ...
        }
    },
Параметр Описание Тип данных
test Модуль для базовой проверки работоспособности приложения Объект
sso Модуль для настройки доменной авторизации Объект
(другие модули в зависимости от сборки приложения) В некоторых случаях могут быть добавлены и иные модули, созданные с использованием API приложения Объект

Описание секции recording

    "recording": {
        "ffmpeg_path": "/usr/bin/ffmpeg",
        "ffmpeg_audio_codec": "aac"
    },
Параметр Описание Тип данных
ffmpeg_path Путь к исполняемому файлу ffmpeg. Например /usr/bin/ffmpeg Строка
ffmpeg_audio_codec Выбор аудио кодека AAC при использовании ffmpeg. По умолчанию aac Строка

Описание секции cabinet

Параметр cabinet не является обязательным для версии приложения от 1.6.0 и выше

    "cabinet": {
        "path": "cabinet"
    }
Параметр Описание Тип данных
path Составная часть, которая используется для формирования URL к основной версии личного кабинета Строка

Описание секции dump

    "dump": {
        "dump_dashboards_interval":6,
        "dump_dashboards_wait":1
    }
Параметр Описание Тип данных
dump_dashboards_interval Интервал в часах автоматического создания после отсутствия изменений указанный в dump_dashboards_wait Число
dump_dashboards_wait Время ожидания в часах, через сколько после последнего изменения будет сделан снапшот Число

Описание секции logs

   "logs":{
        "cef_log":"/home/user/log.cef",
        "syslog":{
            "ip":"127.0.0.1",
            "port":"514"
        },
        "skiplogs":[11]
    }
Параметр Описание Тип данных
cef_log Путь к файлу в который будет записываться события из раздела «Журнал событий» в формате CEF Строка
syslog Позволяет включить вывод логов в syslog Логический или Объект
skiplogs Можно указать список ID событий, которые не будут фиксироваться в логах Массив (Число)

Описание ID событий в журнале логирования

ID Описание
10 Команда создана
11 Команда отредактирована
12 Команда удалена
21 Участник команды создан
22 Участник команды изменен
23 Участник команды удален
31 Доска создана
32 Доска изменена
33 Доска удалена
34 Гостевой доступ включен
35 Гостевой доступ выключен
37 Доска Miro импортирована
40 Проект в команде создан
41 Проект в команде изменен
42 Проект в команде удален
50 Пользователь создан
51 Пользователь изменен
52 Пользователь удален
53 Пользователь восстановлен
54 Для пользователя изменен логин
60 Пользователь авторизовался
61 Пользователь разлогинился
70 Роль добавлена
71 Роль изменена
72 Роль удалена
80 Вложение загружено
81 Вложение удалено
105 LDAP соединение создано
106 LDAP соединение удалено
110 LDAP правило создано
111 LDAP правило изменено
112 LDAP правило удалено
120 LDAP администратор создан
121 LDAP администратор удален

Описание секции miro

   "miro":{
        "clientId":"********",
        "secret":"****************",
        "debug":true
    }
Параметр Описание Тип данных
clientId Клиентский номер приложения Miro (https://developers.miro.com/docs/try-out-the-web-sdk) Строка
secret Секретный ключ приложения Строка
debug Сохранять или нет в таблицу dashboards_import_tasks_items исходные объекты из Миро Логический

Подробнее о настройке механизма импорта можно узнать на данной странице

Описание секции ldap

    "ldap": {
        "interval": 120,
        "debug": true
    }
Параметр Описание Тип данных
interval Количество секунд между запуском процедуры синхронизации по LDAP Число
debug Показ расширенной информации во время выполнения операции Логический

Дополнительные параметры приложения (версия 1.8.0 +)

postgres

    "postgres": {
        "user": "postgres",
        "database": "postgres",
        "password": "PruffmeTest",
        "host": "editboard.mycorp.com",
        "port": "5432"
    },
Параметр Описание Тип данных
postgres Количество секунд между запуском процедуры синхронизации по LDAP Объект
user Имя пользователя PostgreSQL, которое будет использоваться для подключения к базе данных Строка
database Название базы данных, к которой будет осуществляться подключение Строка
password Пароль для пользователя, указанного в параметре user Строка
host Адрес сервера, на котором размещена база данных Строка
port Номер порта, который используется для подключения к базе данных Строка

serveradmin

{
    ...
    "serveradmin":"all",
    ...
}
Параметр Описание Тип данных
serveradmin Если выставлено all, то доступ к разделу «Инстансы» и «Мигратор» предоставляется всем администраторам системы. Для того, чтобы ограничить доступ к данному разделу определенными администраторами, необходимо указать их логины в массиве (["example.admin@editboard.com"]) Массив (Строка) / Строка

admin_stat_interval

{
    ...
    "admin_stat_interval" : 30,
    ...
}
Параметр Описание Тип данных
admin_stat_interval Интервал в секундах между записями мгновенной статистики (пользователи, запушенные доски в моменте) Число

preventcentral

{
    ...
    "preventcentral" : true,
    ...
}
Параметр Описание Тип данных
preventcentral Управляет возможность включать и отключать страницу выбора SSO Логический

Дополнительные параметры приложения (версия 1.10.0 +)

whiteboard_properties

{
    ...
    "modules": {
        "sso": {
            ...
            "whiteboard_properties":{
                "objects":{
                    "menu":{
                        "disable_links":true
                    }
                },
                "media":{
                    "hide_presentation":true,
                    "hide_video":false,
                    "hide_audio":true,
                    "hide_youtube":true,
                    "hide_attachment":true
                },
                "comments":{
                    "disable_links":true,
                    "input_options":{
                        "hide_record_video":true,
                        "hide_record_audio":true,
                        "hide_record_screen":false,
                        "hide_audio": false,
                        "hide_video": true,
                        "hide_photos": false,
                        "hide_files": true,
                        "hide_add_presentation":true,
                        "attachment_extensions":[
                            "png","jpeg","jpg",
                            "pdf",
                            "docx","doc","xlsx","xls",
                            "pptx","ppt",
                            "mp4","mp3",
                            "zip"
                        ]
                    }
                }
            },
            ...
        }
    },
    ...
}
Параметр Описание Тип данных
whiteboard_properties Секция для настройки доступности в приложения функционала, такого как ссылки и вложения Объект
objects Настраивает доступность функционала в для объектов Объект
menu Область настройки. В данном случае это контекстное меню Объект
disable_links Управляет доступностью функционала закрепления гиперссылок на объектах доски Логический
media Область настройки. В данном случае настраивает какие типы медиа материалов будут доступны через инструмент «Материалы» Объект
hide_presentation Скрывает отображение медиа материалов типа "Презентация" Логический
hide_video Скрывает отображение медиа материалов типа "Видео" Логический
hide_audio Скрывает отображение медиа материалов типа "Аудио" Логический
hide_youtube Скрывает отображение медиа материалов типа «Видео из внешних источников (YouTube)» Логический
hide_attachment Скрывает отображение медиа материалов типа "Вложения" Логический
comments Область настройки. В данном случае настраивает какие типы медиа материалов будут доступны через инструмент «Комментарий» Объект
disable_links Управляет доступностью функционала гиперссылок в сообщениях. Если установлено в true, то ссылки преобразовываются в текст Логический
input_options Настройка меню для поля ввода в окне комментария Объект
hide_record_audio Управляет возможностью добавлять голосовые заметки в комментарий Логический
hide_record_screen Логический
hide_audio Управляет возможностью добавлять запись экрана в комментарий Логический
hide_video Управляет возможностью добавлять видео в комментарий Логический
hide_photos Управляет возможностью добавлять фото в комментарий Логический
hide_files Управляет возможностью добавлять вложения в комментарий Логический
hide_add_presentation Управляет возможностью добавлять презентации в комментарий Логический
attachment_extensions Список разрешенных в качестве вложений расширений файлов Массив (Строка)

guest_access

{
    ...
    "guest_access" : "all",
    ...
}
Параметр Описание Тип данных
guest_access Глобальная настройка гостевого доступа в приложении. whiteboard - гостевой доступ выставляется только для определенных досок администратором системы. all - гостевой доступ выставляется любым создателем доски. no - отключения гостевого доступа в системе Строка

import

{
    ...
    "import":{
        "miro":{
            "clientId":"345***",
            "secret":"oikau***",
            "debug":true,
            "threads":5
        },
        "pruffme":true
    },
    ...
}
Параметр Описание Тип данных
import Единая область настройки импорта в приложении Объект
miro Настройки для работа импорта из Miro Объект
pruffme Управление возможностью производить импорт досок, созданных на Pruffme.com Логический

http_info_key

{
    ...
    "http_info_key":"info_key_example"
    ...
}
Параметр Описание Тип данных
http_info_key Предоставление доступа к данным о нагрузке на инстанс (/info), только если в query string передано значение http_info_key Строка
Предыдущая
Веб-инсталлер
Следующая
Настройка Object Storage