readme and changelog fixes

parent 70f456c6
h1. Nginx Push Stream Module h1(#nginx_push_stream_module). Nginx Push Stream Module
A pure stream http push technology for your Nginx setup. A pure stream http push technology for your Nginx setup.
...@@ -6,7 +6,7 @@ Comet made easy and *really scalable*. ...@@ -6,7 +6,7 @@ Comet made easy and *really scalable*.
h2(#changelog). Changelog h2(#changelog). Changelog
Always give a look to changes in Changelog.textile. Always take a look at "CHANGELOG.textile":changelog.
h2(#installing). Installing h2(#installing). Installing
...@@ -35,7 +35,6 @@ h2(#installing). Installing ...@@ -35,7 +35,6 @@ h2(#installing). Installing
</code> </code>
</pre> </pre>
h2(#basic-configuration). Basic Configuration h2(#basic-configuration). Basic Configuration
<pre> <pre>
...@@ -96,7 +95,6 @@ h2(#basic-configuration). Basic Configuration ...@@ -96,7 +95,6 @@ h2(#basic-configuration). Basic Configuration
</code> </code>
</pre> </pre>
h2(#basic-usage). Basic Usage h2(#basic-usage). Basic Usage
You can feel the flavor right now at the command line. Try using more than You can feel the flavor right now at the command line. Try using more than
...@@ -126,8 +124,7 @@ one terminal and start playing http pubsub: ...@@ -126,8 +124,7 @@ one terminal and start playing http pubsub:
h2(#configuration). Configuration h2(#configuration). Configuration
h3(#variables). Variables
h3. Variables
(head). | variable | values | location | (head). | variable | values | location |
|push_stream_channel_id|channel id|push_stream_publisher, push_stream_channels_statistics| |push_stream_channel_id|channel id|push_stream_publisher, push_stream_channels_statistics|
...@@ -163,7 +160,7 @@ location /sub/(.*) { ...@@ -163,7 +160,7 @@ location /sub/(.*) {
</code> </code>
</pre> </pre>
h3. Directives h3(#directives). Directives
(head). | directive | default value | values | context | location | (head). | directive | default value | values | context | location |
|push_stream_channels_statistics|-|-|location|-| |push_stream_channels_statistics|-|-|location|-|
...@@ -186,7 +183,6 @@ h3. Directives ...@@ -186,7 +183,6 @@ h3. Directives
|push_stream_max_number_of_broadcast_channels|unset|number|http, location|(push_stream_subscriber and push_stream_publisher) or main nginx configuration| |push_stream_max_number_of_broadcast_channels|unset|number|http, location|(push_stream_subscriber and push_stream_publisher) or main nginx configuration|
|push_stream_memory_cleanup_timeout|30 seconds|time constant|http, location|(push_stream_subscriber and push_stream_publisher) or main nginx configuration| |push_stream_memory_cleanup_timeout|30 seconds|time constant|http, location|(push_stream_subscriber and push_stream_publisher) or main nginx configuration|
h4(#push_stream_channels_statistics). push_stream_channels_statistics h4(#push_stream_channels_statistics). push_stream_channels_statistics
New in version 0.2.0 New in version 0.2.0
...@@ -233,7 +229,6 @@ POST, publish a message to the channel ...@@ -233,7 +229,6 @@ POST, publish a message to the channel
</code> </code>
</pre> </pre>
h4(#push_stream_subscriber). push_stream_subscriber h4(#push_stream_subscriber). push_stream_subscriber
context: location context: location
...@@ -241,8 +236,7 @@ context: location ...@@ -241,8 +236,7 @@ context: location
Defines a location as a subscriber. This location represents a subscriber's interface to a channel's message queue. Defines a location as a subscriber. This location represents a subscriber's interface to a channel's message queue.
This location only supports GET http method to receive published messages in a stream. This location only supports GET http method to receive published messages in a stream.
h3(#functionality). Functionality
h3. Functionality
h4(#push_stream_header_template). push_stream_header_template [ string ] h4(#push_stream_header_template). push_stream_header_template [ string ]
...@@ -252,7 +246,6 @@ location: push_stream_subscriber ...@@ -252,7 +246,6 @@ location: push_stream_subscriber
The text that will be sended to subscribers when they arrive. The text that will be sended to subscribers when they arrive.
h4(#push_stream_message_template). push_stream_message_template [ string ] h4(#push_stream_message_template). push_stream_message_template [ string ]
default: - default: -
...@@ -269,7 +262,6 @@ location: push_stream_subscriber ...@@ -269,7 +262,6 @@ location: push_stream_subscriber
The content type used on responses to subscribers. Must be complient with push_stream_header_template and push_stream_message_template. The content type used on responses to subscribers. Must be complient with push_stream_header_template and push_stream_message_template.
h4(#push_stream_ping_message_interval). push_stream_ping_message_interval [ time ] h4(#push_stream_ping_message_interval). push_stream_ping_message_interval [ time ]
default: - default: -
...@@ -278,9 +270,7 @@ location: push_stream_subscriber ...@@ -278,9 +270,7 @@ location: push_stream_subscriber
The time interval in which a keepalive message is sent to subscribers. The time interval in which a keepalive message is sent to subscribers.
h3(#message_channel_storage). Message/Channel Storage
h3. Message/Channel Storage
h4(#push_stream_max_reserved_memory). push_stream_max_reserved_memory [ size ] h4(#push_stream_max_reserved_memory). push_stream_max_reserved_memory [ size ]
...@@ -290,7 +280,6 @@ context: http ...@@ -290,7 +280,6 @@ context: http
The size of the memory chunk this module will use to store published messages, channels and other shared structures. 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. When this memory is full any new request for publish a message or subscribe a channel will receive an 500 Internal Server Error response.
h4(#push_stream_store_messages). push_stream_store_messages [ on | off ] h4(#push_stream_store_messages). push_stream_store_messages [ on | off ]
default: off default: off
...@@ -300,7 +289,6 @@ location: push_stream_publisher ...@@ -300,7 +289,6 @@ location: push_stream_publisher
Whether or not message queuing is enabled. Whether or not message queuing is enabled.
If store messages is "On" is needed to set at least one of these two directives push_stream_min_message_buffer_timeout or push_stream_max_message_buffer_length. If store messages is "On" is needed to set at least one of these two directives push_stream_min_message_buffer_timeout or push_stream_max_message_buffer_length.
h4(#push_stream_min_message_buffer_timeout). push_stream_min_message_buffer_timeout [ time ] h4(#push_stream_min_message_buffer_timeout). push_stream_min_message_buffer_timeout [ time ]
default: - default: -
...@@ -309,7 +297,6 @@ location: push_stream_publisher ...@@ -309,7 +297,6 @@ location: push_stream_publisher
The length of time a message may be queued before it is considered expired. If you do not want messages to expire, just not set this directive. The length of time a message may be queued before it is considered expired. If you do not want messages to expire, just not set this directive.
h4(#push_stream_max_message_buffer_length). push_stream_max_message_buffer_length [ number ] h4(#push_stream_max_message_buffer_length). push_stream_max_message_buffer_length [ number ]
default: - default: -
...@@ -318,8 +305,7 @@ location: push_stream_publisher ...@@ -318,8 +305,7 @@ location: push_stream_publisher
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. 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.
h3(#security). Security
h3. Security
h4(#push_stream_authorized_channels_only). push_stream_authorized_channels_only [ on | off ] h4(#push_stream_authorized_channels_only). push_stream_authorized_channels_only [ on | off ]
...@@ -330,7 +316,6 @@ location: push_stream_subscriber ...@@ -330,7 +316,6 @@ location: push_stream_subscriber
Whether or not a subscriber may create a channel by making a request to a push_stream_subscriber location. If set to on, a publisher must send a POST request before a subscriber can request messages on the channel. Otherwise, all subscriber requests to nonexistent channels will get a 403 Forbidden response. Whether or not a subscriber may create a channel by making a request to a push_stream_subscriber location. If set to on, a publisher must send a POST request before a subscriber can request messages on the channel. Otherwise, all subscriber requests to nonexistent channels will get a 403 Forbidden response.
This restriction is not applied to broadcast channels, but to subscribe to a broadcast channel is necessary to subscribe at least to one normal channel, and if this directive is set to on this channel has to be created before. This restriction is not applied to broadcast channels, but to subscribe to a broadcast channel is necessary to subscribe at least to one normal channel, and if this directive is set to on this channel has to be created before.
h4(#push_stream_subscriber_connection_timeout). push_stream_subscriber_connection_timeout [ time ] h4(#push_stream_subscriber_connection_timeout). push_stream_subscriber_connection_timeout [ time ]
default: - default: -
...@@ -340,7 +325,6 @@ location: push_stream_subscriber ...@@ -340,7 +325,6 @@ location: push_stream_subscriber
The length of time a subscriber will stay connected before it is considered expired and disconnected. If you do not want subscribers to be automatically disconnected, just not set this directive. The length of time a subscriber will stay connected before it is considered expired and disconnected. If you do not want subscribers to be automatically disconnected, just not set this directive.
But, this operation is very important to help Nginx recycle memory consumed to send messages to susbscriber, allocated at pool request. But, this operation is very important to help Nginx recycle memory consumed to send messages to susbscriber, allocated at pool request.
h4(#push_stream_max_channel_id_length). push_stream_max_channel_id_length [ number ] h4(#push_stream_max_channel_id_length). push_stream_max_channel_id_length [ number ]
default: - default: -
...@@ -349,7 +333,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi ...@@ -349,7 +333,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi
Maximum permissible channel id length (number of characters). Longer ids will receive an 400 Bad Request response. Maximum permissible channel id length (number of characters). Longer ids will receive an 400 Bad Request response.
h4(#push_stream_broadcast_channel_prefix). push_stream_broadcast_channel_prefix [ string ] h4(#push_stream_broadcast_channel_prefix). push_stream_broadcast_channel_prefix [ string ]
default: - default: -
...@@ -358,7 +341,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi ...@@ -358,7 +341,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi
The string prefix used to identify when a channel is as normal or broadcast channel, example: when you set this directive as "bd_", "bd_ch1" will be a broadcast channel The string prefix used to identify when a channel is as normal or broadcast channel, example: when you set this directive as "bd_", "bd_ch1" will be a broadcast channel
h4(#push_stream_broadcast_channel_max_qtd). push_stream_broadcast_channel_max_qtd [ number ] h4(#push_stream_broadcast_channel_max_qtd). push_stream_broadcast_channel_max_qtd [ number ]
default: - default: -
...@@ -368,7 +350,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi ...@@ -368,7 +350,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi
The maximum number of broadcast channels that a subscriber may sign on the request. The maximum number of broadcast channels that a subscriber may sign on the request.
This directive works in conjunction with push_stream_authorized_channels_only to preserve the server from a kind of attack where a subscriber sign one normal channel and many nonexistent broadcast channels. This directive works in conjunction with push_stream_authorized_channels_only to preserve the server from a kind of attack where a subscriber sign one normal channel and many nonexistent broadcast channels.
h4(#push_stream_max_number_of_channels). push_stream_max_number_of_channels [ number ] h4(#push_stream_max_number_of_channels). push_stream_max_number_of_channels [ number ]
default: - default: -
...@@ -377,7 +358,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi ...@@ -377,7 +358,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi
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. 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.
h4(#push_stream_max_number_of_broadcast_channels). push_stream_max_number_of_broadcast_channels [ number ] h4(#push_stream_max_number_of_broadcast_channels). push_stream_max_number_of_broadcast_channels [ number ]
default: - default: -
...@@ -386,7 +366,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi ...@@ -386,7 +366,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi
The maximum number of concurrent broadcats channels on the server. If you do not want to limit the number of broadcast channels, just not set this directive. The maximum number of concurrent broadcats channels on the server. If you do not want to limit the number of broadcast channels, just not set this directive.
h4(#push_stream_memory_cleanup_timeout). push_stream_memory_cleanup_timeout [ time ] h4(#push_stream_memory_cleanup_timeout). push_stream_memory_cleanup_timeout [ time ]
default: 30 seconds default: 30 seconds
...@@ -396,7 +375,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi ...@@ -396,7 +375,6 @@ location: (push_stream_subscriber and push_stream_publisher) or main nginx confi
The length of time a message or a channel will stay on garbage collection area before it is completly discarded, freeing the shared memory. The minimum length is 30 seconds to ensure that no one is using these elements. The length of time a message or a channel will stay on garbage collection area before it is completly discarded, freeing the shared memory. The minimum length is 30 seconds to ensure that no one is using these elements.
This operation is very important to help Nginx recycle memory consumed to create messages and channels, so do not use a large time. This operation is very important to help Nginx recycle memory consumed to create messages and channels, so do not use a large time.
h2(#attention). Attention h2(#attention). Attention
This module controls everything needed to send the messages to subscribers. This module controls everything needed to send the messages to subscribers.
...@@ -410,3 +388,5 @@ You can do this using the _chunked_transfer_encoding_ directive on subscriber lo ...@@ -410,3 +388,5 @@ You can do this using the _chunked_transfer_encoding_ directive on subscriber lo
chunked_transfer_encoding off; chunked_transfer_encoding off;
</code> </code>
</pre> </pre>
[changelog] https://github.com/wandenberg/nginx-push-stream-module/blob/master/CHANGELOG.textile
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment