Настройка параметров YouGile, файл conf.json
В директории yougile находится файл conf.json — в нём находятся все настройки
серверного приложения в формате JSON.
Для правильной работы системы необходимо указать значение
параметра mainPageUrl. mainPageUrl — это адрес, по которому YouGile
будет доступен для пользователей, например https://yougile.example.com
После редактирования conf.json, чтобы изменения применились, необходимо
перезапустить сервис YouGile.
При редактировании файла conf.json, важно не нарушить формат
JSON, иначе, приложение YouGile
выдаст ошибку при запуске и не запустится. Редактируйте поля
по аналогии с тем, что уже есть в файле и обращайте внимание
на запятые и кавычки (можно где-то забыть поставить или, наоборот,
поставить лишнюю).
Весь список настроек, доступных в conf.json, большинство из них необязательны:
| Имя | Пример значения | Описание |
|---|---|---|
mainPageUrl | "https://yougile.my.com" | Обязательный параметр. Адрес, по которому YouGile доступен для пользователей. Используется для формирования ссылок на страницы системы, например, ссылка на регистрацию, которая отправляется на почту пользователя при его приглашении, или ссылка для восстановления пароля. |
port | 8001 | Порт, по которому YouGile принимает запросы HTTP (некоторые значения портов могут требовать определённых прав при запуске YouGile в некоторых ОС) |
smtp | (см. ниже) | Настройка подключения к почтовому серверу, см. ниже |
emailFrom | "\"Yougile\" <info@my.com>" | Почтовый адрес, от лица которого будут приходить письма пользователей. Если адрес не соответствует аккаунту в настройках поля smtp, то многие почтовые серверы могут запретить отправку письма |
dataUrl | "https://yougile-data.my.com" | Адрес, с которого нужно загружать файлы пользователей (которые хранятся в директории user-data/), если он совпадает с mainPageUrl, то его не нужно указывать |
uploadFileLimit | 50 | Максимальный размер загружаемого пользователем файла в мегабайтах (по умолчанию 50) |
disableInviteUsers | true | Если указано значение true, то пользователи не смогут приглашать новых пользователей в систему (нужно, например, при интеграции с ActiveDirectory) |
disableEmailRecovery | true | Если true, то пользователи не смогут восстанавливать пароли |
lang | "ru" | Язык системы по умолчанию. Если не указан, то язык определяется для каждого пользователя автоматически |
multiCompany | false | Разрешает работу системы в режиме поддержки нескольких компаний (если false, то доступна только 1 основная компания). При включенном параметре пользователи добавляются в аккаунт и распределяются по компаниям через приглашения по почте. |
allowAddCompanies | true | По умолчанию, все пользователи могут создавать новые компании. Если указано false, то пользователи не смогут создавать новые компании. Можно также вместо true или false, указать массив email-ов пользователей, которые смогут создавать компании, пример: ["user1@my.com", "user2@my.com"] |
allowEnterWithoutCompany | false | Если пользователь удалён из всех компаний, то если этот параметр false, то пользователь не может войти в систему, если true, то пользователь может войти и при этом создаётся новая пустая компания для этого пользователя. |
allowExtensions | true | Разрешить системе подключаться к серверу расширений YouGile. Для работы расширений необходимо, чтобы этот параметр был true, чтобы на сервере был доступ по https к адресу plugin.yougile.com и чтобы коробочная версия была доступна по определённому адресу из интернета. При этом будет возможна передача данных между коробочной версией и YouGile |
allowMobileClients | true | Разрешить вход в систему с мобильного приложения. Можно указать true, false или массив email-ов пользователей, которым можно заходить через мобильное приложение. |
rateLimiterOptions | { "enabled": true, "countMultiplier": 1, "timeMultiplier": 1, "restApiCount": 30, "restApiInterval": 60000} | Настройка ограничения количества запросов. Критичные http эндпоинты имеют ограничение на количество запросов к ним (например, вход в систему, регистрация и т.д.), базовое ограничение по запросам для одного ip – это 5 запросов в минуту, с помощью этой настройки можно изменить или отключить это поведение. Ограничения запросов к REST API настраиваются отдельно, параметрами restApiCount (количество разрешённых запросов) и restApiInterval – интервал времени в миллисекундах |
init | (см. ниже) | Настройка запуска серверных скриптов для интеграции (например, для ActiveDirectory). Примеры см. ниже |
logStreams | [{"level": "info", "stream": "stdout"}] | Настройка вывода логов сервера. Пример: [{"level": "info", "stream": "stdout"}, {"level": "error", "path": "/var/tmp/yougile-error.log"}]. Подробнее см. настройки bunyan |
keyExpirationTimeout | 259200000 | Время в миллисекундах в течение которого действует ключ сессии пользователя |
keyExpireOnLogout | false | Если это значение установлено в true, то при выходе из аккаунта пользователя, ключ сессии инвалидируется |
eventLogPath | "./event.log" | Путь к файлу, в который пишется лог событий безопасности. Если параметр не указан, то лог не пишется |
eventLogDailyRotationLimit | 30 | Если этот параметр указан, то лог событий безопасности ротируется раз в день и число в этом параметре определяет количество файлов дней лога, которые хранятся |
restrictUserDataAccess | false | Если указано значение true, то неавторизованный пользователь не сможет получить файл по ссылке. При значении false (значение по умолчанию) любой пользователь может получить файл имея ссылку на него. Для работы параметра необходимо убрать часть location /user-data/ в nginx.conf |