Deployed c5ac2b0 to dev with MkDocs 1.2.4 and mike 1.1.2

This commit is contained in:
fastapi-users-ci
2022-06-07 06:44:49 +00:00
parent 283bc43bf6
commit 9773e41498
5 changed files with 42 additions and 41 deletions

View File

@ -1184,17 +1184,17 @@
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip install <span class="s1">&#39;fastapi-users[redis]&#39;</span>
</code></pre></div>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">import</span> <span class="nn">aioredis</span>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">import</span> <span class="nn">redis.asyncio</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="kn">from</span> <span class="nn">fastapi_users.authentication</span> <span class="kn">import</span> <span class="n">RedisStrategy</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="n">redis</span> <span class="o">=</span> <span class="n">aioredis</span><span class="o">.</span><span class="n">from_url</span><span class="p">(</span><span class="s2">&quot;redis://localhost:6379&quot;</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="n">redis</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">asyncio</span><span class="o">.</span><span class="n">from_url</span><span class="p">(</span><span class="s2">&quot;redis://localhost:6379&quot;</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="k">def</span> <span class="nf">get_redis_strategy</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">RedisStrategy</span><span class="p">:</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a> <span class="k">return</span> <span class="n">RedisStrategy</span><span class="p">(</span><span class="n">redis</span><span class="p">,</span> <span class="n">lifetime_seconds</span><span class="o">=</span><span class="mi">3600</span><span class="p">)</span>
</code></pre></div>
<p>As you can see, instantiation is quite simple. It accepts the following arguments:</p>
<ul>
<li><code>redis</code> (<code>aioredis.Redis</code>): An instance of <code>aioredis.Redis</code>. Note that the <code>decode_responses</code> flag set to <code>True</code> is necessary.</li>
<li><code>redis</code> (<code>redis.asyncio.Redis</code>): An instance of <code>redis.asyncio.Redis</code>. Note that the <code>decode_responses</code> flag set to <code>True</code> is necessary.</li>
<li><code>lifetime_seconds</code> (<code>Optional[int]</code>): The lifetime of the token in seconds. Defaults to <code>None</code>, which means the token doesn't expire.</li>
</ul>
<div class="admonition tip">