Permalink
Fetching contributors…
Cannot retrieve contributors at this time
159 lines (79 sloc) 5.94 KB

Main Configuration

push_stream_shared_memory_size  

syntax: push_stream_shared_memory_size size [name]

default: none

context: http

The size of the memory chunk this module will use to store published messages, channels and other shared structures.
When this memory is full any new request for publish a message or subscribe a channel will receive an 500 Internal Server Error response.
If you have more than one http block on same Nginx instance and do not want they share the same memory, you can set different names to each one with the optional argument name.

push_stream_channel_deleted_message_text  

syntax: push_stream_channel_deleted_message_text string

default: Channel deleted

context: http

release version: 0.2.5

The string used on channel deleted message sent to subscribers when the channel is deleted by a publisher.

push_stream_ping_message_text  

syntax: push_stream_ping_message_text string

default: none

context: http

release version: 0.2.5

The string used on ping message sent to subscribers.

push_stream_channel_inactivity_time  

syntax: push_stream_channel_inactivity_time time

default: 30s

context: http

release version: 0.3.5

The length of time after what a channel will be considered inactive, counted after the last message was published on it or the last subscriber entered on it.
After this time the channel will no longer be available and will be moved to the trash queue.
When the push_stream_authorized_channels_only is set to on, the inactivity time is only used to know when the channel should be moved to trash.

push_stream_message_ttl  

syntax: push_stream_message_ttl time

default: 30m

context: http

The length of time a message may be queued before it is considered expired.

push_stream_max_subscribers_per_channel  

syntax: push_stream_max_subscribers_per_channel number

default: none

context: http

release version: 0.3.1

The maximum number of subscribers accepted per channel. If you do not want to limit number of subscribers access to channels, just not set this directive.

push_stream_max_messages_stored_per_channel  

syntax: push_stream_max_messages_stored_per_channel number

default: none

context: http

The maximum number of messages to store per channel. A channel’s message buffer will retain at most this many most recent messages. If you do not want messages to be discarded by length, just not set this directive.

push_stream_max_channel_id_length  

syntax: push_stream_max_channel_id_length number

default: none

context: http

Maximum permissible channel id length (number of characters). Longer ids will receive an 400 Bad Request response. If you do not want to limit channel id length, just not set this directive.

push_stream_max_number_of_channels  

syntax: push_stream_max_number_of_channels number

default: none

context: http

The maximum number of concurrent channels on the server. If you do not want to limit the number of channels, just not set this directive.

push_stream_max_number_of_wildcard_channels  

syntax: push_stream_max_number_of_wildcard_channels number

default: none

context: http

The maximum number of concurrent wildcard channels on the server. If you do not want to limit the number of wildcard channels, just not set this directive.

push_stream_wildcard_channel_prefix  

syntax: push_stream_wildcard_channel_prefix string

default: none

context: http

The string prefix used to identify a wildcard channel, example: when you set this directive as “bd_”, “bd_ch1” will be a wildcard channel.
A wildcard channel is technically equals to a normal one. It is intended to be used when the push_stream_authorized_channels_only is set to on.

push_stream_events_channel_id  

syntax: push_stream_events_channel_id string

default: none

context: http

release version: 0.6.0

The string identify an events channel where some control messages will be published.
Examples:
{"type": “channel_created”, “channel”: "CHANNEL_ID"}
{"type": “channel_destroyed”, “channel”: "CHANNEL_ID"}
{"type": “client_subscribed”, “channel”: "CHANNEL_ID"}
{"type": “client_unsubscribed”, “channel”: "CHANNEL_ID"}

By default this channel is not available to subscription. To allow subscriptions to it is necessary set push_stream_allow_connections_to_events_channel to on.