Различия
Здесь показаны различия между двумя версиями данной страницы.
| Следующая версия | Предыдущая версия | ||
|
comet:ini-file [2017/08/25 16:16] levhav создано |
comet:ini-file [2019/12/18 01:58] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Параметры допустимые в файле comet.ini ====== | + | <rst>RU::004-Администрирование::005-Настройка файла comet.ini</rst> |
| + | <rst>Header: Файл comet.ini</rst> | ||
| + | ====== Настройка файла comet.ini ====== | ||
| - | [main] | + | * Параметры можно задавать в любом порядке. |
| - | + | * Регистр важен | |
| - | ; Password for accessing comet server api | + | * Комментарий начинается с символа `;` |
| - | password = 0000000000000000000000000000000000000000000000000000000000000000 | + | |
| + | <note important>Статья расчитана на версию [[https://github.com/CppComet/comet-server/releases/tag/3.22|CppComet 3.22]] и старше</note> | ||
| + | ====== Секция [main] ====== | ||
| + | |||
| + | Пароль для доступа из cometQL | ||
| + | <code ini>password = 0000000000000000000000000000000000000000000000000000000000000000</code> | ||
| - | ; Максимальный размер буфера в байтах для работы с сообщениями | + | Максимальный размер буфера в байтах для работы с сообщениями |
| - | buf_size = 10384 | + | <code ini>buf_size = 10384</code> |
| - | ; размер буфера в байтах для хранения фрагментированных сообщений | + | Размер буфера в байтах для хранения фрагментированных сообщений |
| - | fragment_buf_size = 600 | + | <code ini>fragment_buf_size = 600</code> |
| Максимальный размер буфера хранения фрагментированных сообщений | Максимальный размер буфера хранения фрагментированных сообщений | ||
| - | fragment_buf_max_size = 10384 | + | <code>fragment_buf_max_size = 10384</code> |
| - | ; Надо ли выводить в лог комет сервера запросы приходящие через cometQL | + | Надо ли выводить в лог комет сервера запросы приходящие через cometQL |
| - | useQueryLoger = false | + | <code ini>useQueryLoger = false</code> |
| Максимальный размер буфера для ответа на запрос | Максимальный размер буфера для ответа на запрос | ||
| - | answer_buf_size = 1000000 | + | <code ini>answer_buf_size = 1000000</code> |
| + | Комет сервер может отдавать статические файлы. По умолчанию такая возможность отключена. Но если задать параметр base_dir то он начнёт отдавать файлы по имени из этой дерриктории как примитивный http сервер. Поддерживает только get запросы. В секции [content-type] можно задать соответсвие расширения заголовку content-type | ||
| + | <code ini>base_dir = /var/www/html</code> | ||
| + | ====== Секция [statistics] ====== | ||
| - | [statistics] | + | В комет сервере есть механизм сбор статистики использования и отправки на сервер разработчика ( Для чего и какие данные отправляет смотрите здесь http://statistics.comet-server.ru/api/statistics ) |
| + | Чтоб отключить отправку статистики надо выставить значение false | ||
| + | <code ini>allow = true</code> | ||
| - | ; в комет сервере есть механизм сбор статистики использования и отправки на сервер разработчика ( Для чего и какие данные отправляет смотрите здесь http://statistics.comet-server.ru/api/statistics ) | + | ====== Секция [db] ====== |
| - | ; чтоб отключить отправку статистики надо выставить значение 0 | + | Подключение к бд mysql |
| - | interval = 24 | + | <code ini>host = localhost |
| - | + | ||
| - | + | ||
| - | + | ||
| - | [db] | + | |
| - | ; подключение к бд mysql | + | |
| - | host = localhost | + | |
| user = root | user = root | ||
| password = root | password = root | ||
| name = comet_db | name = comet_db | ||
| - | port = 3305 | + | port = 3305</code> |
| - | [ws] | + | ====== Секция [ws] ====== |
| - | ; ip адрес для приёма соединений с вебсокетов | + | ip адрес для приёма соединений с вебсокетов |
| - | ip = 0.0.0.0 | + | <code ini>ip = 0.0.0.0</code> |
| - | ; количество потоков в которые обрабатываются соединения с вебсокетов, каждый поток увеличивает общее потребление памяти примерно 10 - 15 мб так что для малонагруженной конфигурации можно казывать 1 поток | + | Количество потоков в которые обрабатываются соединения с вебсокетов, каждый поток увеличивает общее потребление памяти примерно 10 - 15 мб так что для малонагруженной конфигурации можно казывать 1 поток |
| - | thread_num = 4 ; number of threads for receive message from websockets | + | <code ini>thread_num = 4</code> |
| - | ; комет сервер учитывает количество соединений онлайн и количество сетевых событий, это интервал в секундах между замерами значение 0 не замерять | + | Комет сервер учитывает количество соединений онлайн и количество сетевых событий, это интервал в секундах между замерами значение 0 не замерять |
| - | statistics = 10 ;Interval between load measurements (0 = not measured) | + | <code ini>statistics = 10</code> |
| - | ; порт для прослушивания подключений по вебсокетам | + | Порт для прослушивания подключений по вебсокетам |
| - | port = 8087 ; When connecting to js api, do not forget to specify the port in the node parameter | + | <code ini>port = 8087</code> |
| - | ; интервал в секундах для проверки uptime у подключений, 0 не запускать проверку | + | Интервал в секундах для проверки uptime у подключений, 0 не запускать проверку |
| - | uptimeTestInterval = 600 ; The interval for checking the uptime of the connections (it also corrects the value of the online user count for one) | + | <code ini>uptimeTestInterval = 600</code> |
| - | ; максимальный uptime подключения после которого соединение разрывается принудительно | + | Максимальный uptime подключения после которого соединение разрывается принудительно |
| - | maxUptime = 0 ; The maximum value of uptime after which the connection is disconnected. | + | <code ini>maxUptime = 0</code> |
| - | ; список хостов через запятую с которых разрешено подключатся из javascript api (проверяется на основе http заголовка ) по умолчанию ограничения нет | + | Список хостов через запятую с которых разрешено подключатся из javascript api (проверяется на основе http заголовка ) по умолчанию ограничения нет |
| - | host = * ; comma separated hosts from which allows receiving connections, or asterisk symbol for allowing connections from any host | + | <code ini>host = *</code> |
| - | [cometql] | + | Только для работы в кластере. Список параметров для подключения к другим серверам кластера. Для каждого сервера в кластере надо указать свою строку подключения. Строка регистрозависимая. |
| - | ip = 0.0.0.0 | + | Server - имя хоста сервера |
| + | Database - версия апи. Сейчас всегда CometQL_v1 | ||
| + | Uid - имя пользователя, всегда root | ||
| + | Pwd - пароль | ||
| + | Port - порт для подключения к CometQL | ||
| + | <code>cluster = []Server=127.0.0.1,Database=CometQL_v1,Uid=root,Pwd=0000000000000000000000000000000000000000000000000000000000000000,Port=3311</code> | ||
| + | |||
| + | |||
| + | ====== Секция [cometql] ====== | ||
| + | <code ini>ip = 0.0.0.0 | ||
| thread_num = 3 ; number of threads for receive message from cometql | thread_num = 3 ; number of threads for receive message from cometql | ||
| statistics = 10 | statistics = 10 | ||
| port = 3300 | port = 3300 | ||
| uptimeTestInterval = 600 | uptimeTestInterval = 600 | ||
| - | maxUptime = 0 | + | maxUptime = 0 </code> |
| | | ||
| - | [log] | + | ====== Секция [content-type] ====== |
| - | ; настройка уровня логирования чем выше число тем больше логов сыпится. | + | |
| - | ; 0 не выводить | + | |
| - | ; 100 критические ошибки | + | |
| - | ; 200 ошибки | + | |
| - | ; 300 предупреждения | + | |
| - | ; 400 лог | + | |
| - | ; 500 режим отладки | + | |
| - | ; параметр выставляет общий для всех подсистем максимальный уровень логирования | + | Позволяет задать соответсвие content-type и типа файла. |
| - | level = 200; Logging level (600 output all, 200 errors only) | + | |
| - | ; Logging levels for individual subsystems | + | на пример так: |
| - | ; Change only if debugging is necessary | + | <code ini>js = text/javascript |
| + | css = text/css</code> | ||
| + | ====== Секция [log] ====== | ||
| + | Настройка уровня логирования чем выше число тем больше логов сыпится. | ||
| + | * 0 - не выводить | ||
| + | * 100 - критические ошибки | ||
| + | * 200 - ошибки | ||
| + | * 300 - предупреждения | ||
| + | * 400 - лог | ||
| + | * 500 - режим отладки | ||
| - | ; уровни логирования для отдельных подсистем для того чтоб было можно смотреть лог по отдельности для разных событий используется для удобства отладки | + | Параметр выставляет общий для всех подсистем максимальный уровень логирования |
| - | Any = 500 | + | <code ini>level = 200; </code> |
| + | |||
| + | Уровни логирования для отдельных подсистем для того чтоб было можно смотреть лог по отдельности для разных событий используется для удобства отладки | ||
| + | <code ini>Any = 500</code> | ||
| - | ; события от класса логера | + | События от класса логера |
| - | TagLoger = 500 | + | <code ini>TagLoger = 500</code> |
| - | ; события класса хранения настроек | + | События класса хранения настроек |
| - | appConf = 500 | + | <code ini>appConf = 500</code> |
| - | ; события от класса взаимодействия через pipe (в операционной системе) | + | События от класса взаимодействия через pipe (в операционной системе) |
| - | pipeCommands = 500 | + | <code ini>pipeCommands = 500</code> |
| - | ; модуль сбора статистики | + | Модуль сбора статистики |
| - | statistics = 500 | + | <code ini>statistics = 500</code> |
| - | ; отключение соединений по превышению uptime | + | Отключение соединений по превышению uptime |
| - | removeOldConnections = 500 | + | <code ini>removeOldConnections = 500</code> |
| - | ; работа с mysql | + | Работа с mysql |
| - | MySqlServer = 500 | + | <code ini>MySqlServer = 500</code> |
| - | ; класс работы с данными пользователей (авторизация, время последнего онлайна) | + | Класс работы с данными пользователей (авторизация, время последнего онлайна) |
| - | UserIndex = 500 | + | <code ini>UserIndex = 500</code> |
| - | ; класс пользователя (авторизация, время последнего онлайна) | + | Класс пользователя (авторизация, время последнего онлайна) |
| - | UserItem = 500 | + | <code ini>UserItem = 500</code> |
| - | ; работа с вебсокетами | + | Работа с вебсокетами |
| - | ClientServer = 500 | + | <code ini>ClientServer = 500</code> |
| - | ; устаревшая секция работы с php api | + | Устаревшая секция работы с php api |
| - | ServerServer = 500 | + | <code ini>ServerServer = 500</code> |
| - | ; работа с редис (устаревшая секция) | + | Работа с редис (устаревшая секция) |
| - | SimpleRedisClient = 500 | + | <code ini>SimpleRedisClient = 500</code> |
| - | ; приём и распределение сетевых соединений | + | Приём и распределение сетевых соединений |
| - | tcpServer = 500 | + | <code ini>tcpServer = 500</code> |
| - | ; заготовки кластеризапции ещё не всё готово | + | Заготовки кластеризапции ещё не всё готово |
| - | CometQLCluster = 500 | + | <code ini>CometQLCluster = 500</code> |
| - | ; работа с авторизацией от cometql подключений | + | Работа с авторизацией от cometql подключений |
| - | devManager = 500 | + | <code ini>devManager = 500</code> |
| + | |||
| + | Отправка запросов к бд mysql | ||
| + | <code ini>dbLink = 500</code> | ||
| + | |||
| + | ====== Секция [freeswitch] ====== | ||
| + | |||
| + | Секция [freeswitch] в comet.ini поднимает на указанном порту и ip адресе http интерфейс который отвечает за механизм единой с freeswitch авторизации пользователей. | ||
| + | |||
| + | <code ini>ip = 0.0.0.0 | ||
| + | thread_num = 3 | ||
| + | statistics = 10 | ||
| + | port = 84 </code> | ||
| - | ; отправка запросов к бд mysql | + | <note important>Важно что этот интерфейс не должен быть доступен из внешнй сети. На данный момент не реализована поддержка авторизации (планируется в следующих релизах) и соответственно во избежание утечки данных авторизации надо разрешить доступ к этому порту только доверенным ip адресам с вашими серверами FreeSwitch. Ограничить доступ можно средствами фаервола. |
| - | dbLink = 500 | + | </note> |