Настройки web-сервера Oktell — различия между версиями

Версия 09:02, 12 июля 2022

Техническая документация / Администрирование / Общие Настройки / Системные настройки / Настройки web-сервера Oktell

Встроенный web-сервер Oktell

• обрабатывает поступающие запросы в рамках Web-API (требуется базовая авторизация под учетной записью любого пользователя, имеющему привилегию исполнения методов Web-API).
• выдает страницы из папки WWW (авторизация не требуется).
• обслуживает подключения WebSocket для работы пользователей в web-клиенте и в решениях, интегрированных с помощью Oktell.js или непосредственно по интеграционному протоколу Oktell WebSocket (авторизация происходит в рамках интеграционного протокола под учетной записью одного из пользователей).

В случае необходимости сервисного доступа к API необходимо создать дополнительную учетную запись пользователя, снабдить его правами и использовать его авторизационную информацию.

Способ соединения с сервером Oktell

Позволяет выбрать режим доступа к HTTP веб-серверу службы Oktell. По умолчанию выключен

• Неактивен - веб-сервер не доступен, прослушивание портов не осуществляется.
• HTTP & WebSocket - веб-сервер работает на незащищенных каналах, осуществляется прослушивание портов для незащищенных соединений.
• HTTPS & WebSocketSecure - веб-сервер работает на защищенных каналах, а подключения по незащищенным каналам перенаправляются на защищенные адреса. Прослушиваются оба вида портов. Этот режим работы требует наличия серверного сертификата X.509 с private-ключом для организации подключения.

Порты веб-сервера Oktell для незащищенных соединений

Список портов через запятую, на которых осуществляется прослушивание подключений к веб-серверу по незащищенным каналам. До версии 130325 был отдельный порт для http-web-сервера и для websocket-сервера. Поскольку теперь слушатели и порты единые, то в целях наследования настроек при обновлении список портов содержит 4055, 4066 и опционально 80.

Порты веб-сервера Oktell для защищенных соединений (TLS)

Список портов через запятую, на которых осуществляется прослушивание подключений к веб-серверу по защищенным каналам. По умолчанию 443.

Домен для формирования ссылок на скачивание

При запросах к веб-серверу или веб-сокет-серверу, отвечающих за предоставление доступа к данным, в ответах публикуются ссылки на скачивания разных файлов (например факсимильных сообщений, или файлов записей разговоров). Такая ссылка может быть абсолютной или относительной. Указанное значение применяется в случае необходимости формирования абсолютной ссылки в качестве доменного имени.

Путь к папке-хранилищу закачанных документов

Устанавливает папку на сервере, куда размещаются все закачиваемые на веб-сервер файлы. По умолчанию и в случае пустого значения в качестве хранилища выступает подкаталог LocalStorage в рабочем каталоге сервера.

Дополнительно этот каталог используется для хранения фотографий пользователей, привязанных в настройках учетных записей (подкаталог UserPhotoCache), для обмена файлами между пользователями web-клиента (подкаталог MessageFiles)

Служебный сценарий генерации 404 ошибки

Позволяет указать служебный сценарий, который запустится для обработки запросов, не являющихся запросами к Web-API или страницами из папки WWW. В противном случае, если сценарий не указан, веб-сервер системы на подобные запросы вернёт ответ с кодом 404.

На вход в сценарий передаются следующие параметры:

• Входной параметр 1 - полная строка запроса
• Входной параметр 2 - HTTP-заголовки запроса
• Входной параметр 3 - адрес вызывающей(удалённой) стороны
• Входной параметр 4 - данные из тела запроса или путь к временному файлу(если объём данных более 64Кб)
• Входной параметр 5 - HTTP-метод.

На выходе сценарий должен вернуть результат обработки запроса и код ответа через служебные переменные:

• Возвращаемое значение 1 - строка-результат выполнения сценария или путь к файлу
• Возвращаемое значение 2 - HTTP-код ответ или строка "file"(если Возвращаемое значение 1 содержит путь к файлу)
• Возвращаемое значение 3 - дополнительные HTTP-заголовки ответа.

Адрес web-клиента

Начиная с версии программы 2.11.140701, параметр не используется.

Позволяет установить и зарегистрировать доменное имя *.oktell.ru, связанное с данным сервером для работы web-клиента. После удачной регистрации в статусной строке desktop-приложения у всех пользователей появится подсказка с адресом web-клиента.

Список IP-адресов сервера Oktell

Позволяет связать зарегистрированное доменное имя с адресами сервера Oktell. Адреса перечисляются через запятую. Таким образом при обращении к web-клиенту по зарегистрированному доменному имени, подключение из браузера создается на один из этих адресов. Для работы внутри офиса это может быть внутренний адрес сервера - этого будет достаточно, поскольку подключение организуется браузером, также использующимся внутри офиса. Для других случаев необходимо указание внешних адресов, по которым клиент снаружи смог бы подключиться к серверу телефонии.