Довідка по файлу конфігурації

Мова: Українська

Цю статтю перекладено з англійської за допомогою ШІ, тому вона може містити помилки. Ваші відгуки допоможуть нам її покращити.

Під час запуску сервер ActivityInfo зчитує свою конфігурацію з файлу config.ini, розташування якого залежить від типу інсталяції:

Windows: C:\Program Files\ActivityInfo\config.ini, або той самий каталог, що й activityinfo.exe
Debian: /opt/activityinfo/config.ini
Docker: корінь тому activityinfo.
Інші: поточний робочий каталог

Файл конфігурації складається з кількох іменованих розділів, у яких визначаються пари ключ-значення. Назви ключів нечутливі до регістру.

Наприклад:

[Server]
Http Port=80
Https Port=443

[Data]
Data Directory = /opt/activityinfo/data

[Mail]
Enabled = True
Sender Address = notifications@activityinfo.org
Host = smtp.postmarkapp.com
Port = 25

Розділ Server

Розділ Server налаштовує веб-сервер.

Ключ	Опис	Значення за замовчуванням
Http Port	Порт TCP, на якому прослуховуються HTTP-з'єднання.	8081
Https Port	Порт TCP, на якому прослуховуються HTTPS-з'єднання.	8081
Https Proxy	Якщо встановлено значення "Істина", ActivityInfo не буде прослуховувати HTTPS-з'єднання, а очікуватиме, що висхідний проксі-сервер або балансувальник навантаження забезпечить завершення SSL.	Хибність
Domain	Ім'я хоста сервера. Використовується при перенаправленні з http на https, а також в URL-адресах, що містяться в емейлах, надісланих користувачам.	localhost

Розділ Data

Розділ Data визначає, де ActivityInfo має зберігати свої дані.

Ключ	Опис	Значення за замовчуванням
Data Directory	Каталог, у якому ActivityInfo зберігає файли своєї бази даних.	Поточний робочий каталог

Розділ Mail налаштовує спосіб надсилання ActivityInfo емейлів-сповіщень, наприклад, запрошень користувачеві для доступу до бази даних або емейлів для скидання пароля. Наразі автономний сервер ActivityInfo підтримує надсилання емейлів лише через SMTP.

Ключ	Опис	Значення за замовчуванням
Enabled	"Істина", якщо сервер має надсилати емейли, або "Хибність", якщо не має.	Хибність
Sender Address	Адреса емейлу, що використовується як адреса "Відправник", коли сервер надсилає емейли.	admin@localhost
Host	Ім'я хоста SMTP-сервера.	localhost
Port	Номер порту TCP SMTP-сервера.	25
Username	Ім'я користувача, що використовується для автентифікації на SMTP-сервері.
Password	Пароль, що використовується для автентифікації на SMTP-сервері.

Постачальники ідентифікації

ActivityInfo підтримує єдиний вхід (SSO) через зовнішніх постачальників ідентифікації (IdP). Кожен IdP налаштовується у власному розділі, що має назву " IdP", наприклад:

[MyAzure IdP]
Type = OPENID_CONNECT
URL = https://login.microsoftonline.com/common/v2.0
Client ID = XYZ1234
Client Secret = ZDFSDF
Email Domains = example.gov, partner.org

[Google IdP]
Type = OPENID_CONNECT
URL = https://accounts.google.com
Client ID = XYZ1234
Client Secret = ZDFSDF
Email Domains = gmail.com, bedatadriven.com

[AD IdP]
Type = ADSI

Зверніть увагу, що ІД постачальника, "My Azure" та "Google" у наведених вище прикладах, є довільними. Ви можете вибрати будь-яке ім'я, що відповідає шаблону [A-Za-z]{1,15}.

Автономний сервер ActivityInfo підтримує постачальників OpenID Connect.

Постачальники OpenID Connect

Для постачальників OpenID Connect потрібні такі ключі:

Ключ	Опис
Type	OPENID_CONNECT
URL	Базова URL-адреса OpenID Connect
Client ID	Виданий постачальником ІД клієнта
Client Secret	Виданий постачальником секретний ключ клієнта
Email domains	Список доменів ел. пошти, розділених комами, які повинні проходити автентифікацію через цього постачальника.

Інтеграції із зовнішніми API

Ключ	Опис	Значення за замовчуванням
Mapbox Public Access Token	Загальнодоступний токен доступу для вашого облікового запису Mapbox.	Пустий

Розділ Security

Примітка: ці параметри доступні, починаючи з версії 4.1.3 автономного сервера.

Ключ	Опис	Значення за замовчуванням
Strict Transport Security	Може бути "Увімкнено", "Тестування" або "Вимкнено". Додає заголовок Strict-Transport-Security до всіх запитів, гарантуючи, що користувачі отримують доступ до ActivityInfo лише через безпечне, зашифроване з'єднання.	Вимкнено
Account Disclosure	Може бути "Увімкнено" або "Вимкнено". Визначає, чи дозволено серверу розкривати інформацію про існування облікового запису користувача. Якщо увімкнено, сервер інформуватиме користувачів, коли їхній емейл неправильний або не зареєстрований у системі, що робить ActivityInfo доступнішим. Однак це дозволяє зловмисникам визначити, чи має певний користувач обліковий запис.	Увімкнено
XSS Protection	Може бути "Увімкнено" або "Вимкнено". Визначає, чи надсилає сервер заголовок X-XSS-Protection зі значенням 1; mode=block. Цей заголовок застарів і не рекомендується, оскільки може блокувати легітимні запити.	Вимкнено

Розділ Malware

Примітка: ці параметри доступні, починаючи з версії 5.0.0 автономного сервера. Вони налаштовують сканування завантажених вкладень на наявність шкідливого програмного забезпечення за допомогою ClamAV. Для сканування потрібен окремо встановлений демон ClamAV (clamd); інструкції з інсталяції та опис роботи сканування див. у розділі Сканування на наявність шкідливого ПЗ за допомогою ClamAV.

Ключ	Опис	Значення за замовчуванням
Enabled	Може бути "Істина" або "Хибність". Визначає, чи скануються завантажені вкладення на наявність шкідливого ПЗ. Якщо встановлено значення "Хибність", вкладення приймаються та обслуговуються без сканування.	Істина
Socket	Шлях до сокета домену Unix clamd. Використовується, коли хост не встановлено.	/var/run/clamav/clamd.ctl
Host	Ім'я хоста або IP-адреса сервера clamd, доступного через TCP. Якщо встановлено, має пріоритет над сокетом.	Пустий
Port	Порт TCP сервера clamd. Використовується лише тоді, коли встановлено хост.	3310

Використання змінних середовища

Починаючи з версії 4.0.15, ActivityInfo також може зчитувати деякі налаштування зі змінних середовища у форматі "ACTIVITYINFO_{SECTION}_{KEY NAME}", де пробіли замінюються на підкреслення.

Наприклад:

ACTIVITYINFO_SERVER_HTTP_PORT
ACTIVITYINFO_SERVER_HTTPS_PORT
ACTIVITYINFO_SERVER_HTTPS_PROXY
ACTIVITYINFO_DATA_DATA_DIRECTORY
ACTIVITYINFO_MAIL_ENABLED
ACTIVITYINFO_MAIL_SENDER_ADDRESS
ACTIVITYINFO_MAIL_HOST
ACTIVITYINFO_MAIL_PORT
ACTIVITYINFO_MALWARE_ENABLED
ACTIVITYINFO_MALWARE_SOCKET
ACTIVITYINFO_MALWARE_HOST
ACTIVITYINFO_MALWARE_PORT

Якщо ключ присутній і у файлі конфігурації, і у змінній середовища, пріоритет надається файлу конфігурації.

Наступний елемент

Встановлення на Red Hat