Registrar
Documentation based on repostory git version commit 2.0.8
Module Registrar
The ModuleRegistrar module handles REGISTERs for domains it is in charge of, and store the address of record in order to allow routing requests destinated to the client who registered. REGISTERs for other domains are simply ignored and given to the next module.
----
Configuration options:
Name | Description | Default Value | Type |
---|---|---|---|
enabled | Indicate whether the module is activated. | true | Boolean |
filter | A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2') | BooleanExpr | |
reg-domains | List of whitespace separated domain names which the registar is in charge of. It can eventually be the '*' (wildcard) in order to match any domain name. | localhost | StringList |
reg-on-response | Register users based on response obtained from a back-end server. This mode is for using flexisip as a front-end server to hold client connections but registeracceptance is deferred to backend server to which the REGISTER is routed. | false | Boolean |
max-contacts-by-aor | Maximum number of registered contacts per address of record. | 12 | Integer |
unique-id-parameters | List of contact URI parameters that can be used to identify a user's device. The contact parameters are searched in the order of the list, the first matching parameter is used and the others ignored. | +sip.instance pn-tok line | StringList |
max-expires | Maximum expire time for a REGISTER, in seconds. | 86400 | Integer |
min-expires | Minimum expire time for a REGISTER, in seconds. | 60 | Integer |
force-expires | Set a value that will override expire times given by the REGISTER requests. A null or negative value disables that feature. If it is enabled, max-expires and min-expires will not have any effect. | -1 | Integer |
static-records-file | File containing the static records to add to database on startup. Format: one 'sip_uri contact_header' by line. Example: | String | |
static-records-timeout | Timeout in seconds after which the static records file is re-read and the contacts updated. | 600 | Integer |
db-implementation | Implementation used for storing the contact URIs of each address of record. Two backends are available: | internal | String |
redis-server-domain | Hostname or address of the Redis server. | localhost | String |
redis-server-port | Port of the Redis server. | 6379 | Integer |
redis-auth-password | Authentication password for Redis. Empty to disable. | String | |
redis-server-timeout | Timeout in milliseconds of the Redis connection. | 1500 | Integer |
redis-slave-check-period | When Redis is configured in master-slave, Flexisip will periodically ask which Redis instances are the slaves and the master. This is the period with which it will query the server. It will then determine whether is is connected to the master, and if not, let go of the connection and migrate to the master. | 60 | Integer |
service-route | Sequence of proxies (space-separated) where requests will be redirected through (RFC3608) | String | |
message-expires-param-name | Name of the custom Contact header parameter which is to indicate the expire time for chat message delivery. | message-expires | String |
register-expire-randomizer-max | If not zero, the expire time put in the 200 OK response won't be the one required by the user agent, but will be slightly modified by substracting a random value. The value given by this parameter is the maximum percentage of the initial expire that can be substracted. | 0 | Integer |