소스 검색

Update text on prebinding.

JC Brand 11 년 전
부모
커밋
762ba21c7d
6개의 변경된 파일60개의 추가작업 그리고 24개의 파일을 삭제
  1. BIN
      docs/doctrees/index.doctree
  2. 20 7
      docs/html/_sources/index.txt
  3. 19 9
      docs/html/index.html
  4. 1 1
      docs/html/objects.inv
  5. 0 0
      docs/html/searchindex.js
  6. 20 7
      docs/source/index.rst

BIN
docs/doctrees/index.doctree


+ 20 - 7
docs/html/_sources/index.txt

@@ -206,16 +206,20 @@ Server-side authentication
 
 .. _`Session Support`:
 
-Pre-binding and Single Session Support
---------------------------------------
+Prebinding and Single Session Support
+-------------------------------------
 
 It's possible to enable single-site login, whereby users already
 authenticated in your website will also automatically be logged in on the chat server,
 
+This session should also persist across page loads. In other words, we don't
+want the user to have to give their chat credentials every time they reload the
+page.
+
 To do this you will require a `BOSH server <http://xmpp.org/about-xmpp/technology-overview/bosh/>`_
 for converse.js to connect to (see the `bosh_service_url`_ under `Configuration variables`_)
-as well as a BOSH client on your own server that will do the pre-authentication before the web page
-loads.
+as well as a BOSH client on your own server (written for example in Python, Ruby or PHP) that will
+do the pre-authentication before the web page loads.
 
 .. note::
     A BOSH server acts as a bridge between HTTP, the protocol of the web, and
@@ -227,10 +231,19 @@ loads.
 Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
 
 When you authenticate to the XMPP server on your backend application (for
-example a BOSH client in Django), you'll receive two tokens, RID (request ID) and SID (session ID).
+example via a BOSH client in Django), you'll receive two tokens, RID (request ID) and SID (session ID).
+
+The **Session ID (SID)** is a unique identifier for the current *session*. This
+number stays constant for the entire session.
+
+The **Request ID (RID)** is a unique identifier for the current *request* (i.e.
+page load). Each page load is a new request which requires a new unique RID.
+The best way to achieve this is to simply increment the RID with each page
+load.
 
-These tokens then need to be passed back to converse.js running in your
-browser, where you they will be used to attach to the existing session.
+When you initialize converse.js in your browser, you need to pass it these two
+tokens. Converse.js will then use them to attach to the session you just
+created.
 
 You can embed the RID and SID tokens in your HTML markup or you can do an
 XMLHttpRequest call to your server and ask it to return them for you.

+ 19 - 9
docs/html/index.html

@@ -74,7 +74,7 @@
 </ul>
 </li>
 <li><a class="reference internal" href="#server-side-authentication" id="id9">Server-side authentication</a><ul>
-<li><a class="reference internal" href="#pre-binding-and-single-session-support" id="id10">Pre-binding and Single Session Support</a></li>
+<li><a class="reference internal" href="#prebinding-and-single-session-support" id="id10">Prebinding and Single Session Support</a></li>
 <li><a class="reference internal" href="#setting-up-a-bosh-server" id="id11">Setting up a BOSH server</a></li>
 </ul>
 </li>
@@ -174,7 +174,7 @@ practical.</p>
 <p>You&#8217;ll most likely want to implement some kind of single-signon solution for
 your website, where users authenticate once in your website and then stay
 logged into their XMPP session upon page reload.</p>
-<p>For more info on this, read: <a class="reference internal" href="#pre-binding-and-single-session-support">Pre-binding and Single Session Support</a>.</p>
+<p>For more info on this, read: <a href="#id48"><span class="problematic" id="id49">`Pre-binding and Single Session Support`_</span></a>.</p>
 <p>You might also want to have more fine-grained control of what gets included in
 the minified Javascript file. Read <a class="reference internal" href="#configuration">Configuration</a> and <a class="reference internal" href="#minification">Minification</a> for more info on how to do
 that.</p>
@@ -275,14 +275,17 @@ the cross-domain restriction is <tt class="docutils literal"><span class="pre">m
 </div>
 <div class="section" id="server-side-authentication">
 <h2><a class="toc-backref" href="#id9">Server-side authentication</a><a class="headerlink" href="#server-side-authentication" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="pre-binding-and-single-session-support">
-<span id="session-support"></span><h3><a class="toc-backref" href="#id10">Pre-binding and Single Session Support</a><a class="headerlink" href="#pre-binding-and-single-session-support" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="prebinding-and-single-session-support">
+<span id="session-support"></span><h3><a class="toc-backref" href="#id10">Prebinding and Single Session Support</a><a class="headerlink" href="#prebinding-and-single-session-support" title="Permalink to this headline">¶</a></h3>
 <p>It&#8217;s possible to enable single-site login, whereby users already
 authenticated in your website will also automatically be logged in on the chat server,</p>
+<p>This session should also persist across page loads. In other words, we don&#8217;t
+want the user to have to give their chat credentials every time they reload the
+page.</p>
 <p>To do this you will require a <a class="reference external" href="http://xmpp.org/about-xmpp/technology-overview/bosh/">BOSH server</a>
 for converse.js to connect to (see the <a class="reference internal" href="#bosh-service-url">bosh_service_url</a> under <a class="reference internal" href="#configuration-variables">Configuration variables</a>)
-as well as a BOSH client on your own server that will do the pre-authentication before the web page
-loads.</p>
+as well as a BOSH client on your own server (written for example in Python, Ruby or PHP) that will
+do the pre-authentication before the web page loads.</p>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
 <p class="last">A BOSH server acts as a bridge between HTTP, the protocol of the web, and
@@ -293,9 +296,16 @@ translating our HTTP requests into XMPP stanzas and vice versa.</p>
 </div>
 <p>Jack Moffitt has a great <a class="reference external" href="http://metajack.im/2008/10/03/getting-attached-to-strophe">blogpost</a> about this and even provides an <a class="reference external" href="https://github.com/metajack/strophejs/tree/master/examples/attach">example Django application</a> to demonstrate it.</p>
 <p>When you authenticate to the XMPP server on your backend application (for
-example a BOSH client in Django), you&#8217;ll receive two tokens, RID (request ID) and SID (session ID).</p>
-<p>These tokens then need to be passed back to converse.js running in your
-browser, where you they will be used to attach to the existing session.</p>
+example via a BOSH client in Django), you&#8217;ll receive two tokens, RID (request ID) and SID (session ID).</p>
+<p>The <strong>Session ID (SID)</strong> is a unique identifier for the current <em>session</em>. This
+number stays constant for the entire session.</p>
+<p>The <strong>Request ID (RID)</strong> is a unique identifier for the current <em>request</em> (i.e.
+page load). Each page load is a new request which requires a new unique RID.
+The best way to achieve this is to simply increment the RID with each page
+load.</p>
+<p>When you initialize converse.js in your browser, you need to pass it these two
+tokens. Converse.js will then use them to attach to the session you just
+created.</p>
 <p>You can embed the RID and SID tokens in your HTML markup or you can do an
 XMLHttpRequest call to your server and ask it to return them for you.</p>
 <p>Below is one example of how this could work. An Ajax call is made to the

+ 1 - 1
docs/html/objects.inv

@@ -4,4 +4,4 @@
 # The remainder of this file is compressed using zlib.
 xÚmÎÁ
 à à{Ÿ"°³ƒ]÷;
->�]‚4б°½ý,¦°ÂnáÏ÷‡¤Œ�‘Þ 
ïÑ-ÁÜ |LÒÅum)^à™q‹�=š<ñŸÒ‘jcP!W_ëŽL™`vž:	™A¶RrmçÖÏmuæps%³ô}`Žlú³VÏÙÁ¦/ÆnTX
+>�]‚4б°½ý,¦°ÂnáÏ÷‡¤Œ�‘Þ 
ïÑ-ÁÜ |LÒÅum)^à™q‹�=š<ñŸÒ‘jcP!W_ëŽL™`vž:	™A¶RrmçÖÏmuæps¥¥¯{pŒ`ûеzÍ5}xÊT+

파일 크기가 너무 크기때문에 변경 상태를 표시하지 않습니다.
+ 0 - 0
docs/html/searchindex.js


+ 20 - 7
docs/source/index.rst

@@ -206,16 +206,20 @@ Server-side authentication
 
 .. _`Session Support`:
 
-Pre-binding and Single Session Support
---------------------------------------
+Prebinding and Single Session Support
+-------------------------------------
 
 It's possible to enable single-site login, whereby users already
 authenticated in your website will also automatically be logged in on the chat server,
 
+This session should also persist across page loads. In other words, we don't
+want the user to have to give their chat credentials every time they reload the
+page.
+
 To do this you will require a `BOSH server <http://xmpp.org/about-xmpp/technology-overview/bosh/>`_
 for converse.js to connect to (see the `bosh_service_url`_ under `Configuration variables`_)
-as well as a BOSH client on your own server that will do the pre-authentication before the web page
-loads.
+as well as a BOSH client on your own server (written for example in Python, Ruby or PHP) that will
+do the pre-authentication before the web page loads.
 
 .. note::
     A BOSH server acts as a bridge between HTTP, the protocol of the web, and
@@ -227,10 +231,19 @@ loads.
 Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
 
 When you authenticate to the XMPP server on your backend application (for
-example a BOSH client in Django), you'll receive two tokens, RID (request ID) and SID (session ID).
+example via a BOSH client in Django), you'll receive two tokens, RID (request ID) and SID (session ID).
+
+The **Session ID (SID)** is a unique identifier for the current *session*. This
+number stays constant for the entire session.
+
+The **Request ID (RID)** is a unique identifier for the current *request* (i.e.
+page load). Each page load is a new request which requires a new unique RID.
+The best way to achieve this is to simply increment the RID with each page
+load.
 
-These tokens then need to be passed back to converse.js running in your
-browser, where you they will be used to attach to the existing session.
+When you initialize converse.js in your browser, you need to pass it these two
+tokens. Converse.js will then use them to attach to the session you just
+created.
 
 You can embed the RID and SID tokens in your HTML markup or you can do an
 XMLHttpRequest call to your server and ask it to return them for you.

이 변경점에서 너무 많은 파일들이 변경되어 몇몇 파일들은 표시되지 않았습니다.