python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 2477fdf to 10.0 with MkDocs 1.2.4 and mike 1.1.2

Browse Source
This commit is contained in:
fastapi-users-ci
2022-05-10 06:43:20 +00:00
parent 794deba1c6
commit 9a2bff59ee
6 changed files with 100 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
10.0/configuration/authentication/strategies/redis/index.html
View File

@@ -575,6 +575,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
@@ -1135,6 +1142,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
@@ -1165,14 +1179,18 @@
<h1 id="redis">Redis<a class="headerlink" href="#redis" title="Permanent link">&para;</a></h1>
<p><a href="https://redis.io/">Redis</a> is an ultra-fast key-store database. As such, it's a good candidate for token management. In this strategy, a token is generated and associated with the user id. in the database. On each request, we try to retrieve this token from Redis to get the corresponding user id.</p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>
<p>You should install the library with the optional dependencies for Redis:</p>
<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-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">import</span> <span class="nn">aioredis</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-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-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-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-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-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-0-7" name="__codelineno-0-7" href="#__codelineno-0-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>
<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>
<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-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>

6
10.0/index.html
View File

@@ -1267,7 +1267,7 @@
<a href="https://badge.fury.io/py/fastapi-users"><img alt="PyPI version" src="https://badge.fury.io/py/fastapi-users.svg" /></a>
<a href="https://pepy.tech/project/fastapi-users"><img alt="Downloads" src="https://pepy.tech/badge/fastapi-users" /></a></p>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<p><a href="#contributors-"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-55-orange.svg?style=flat-square" /></a></p>
<p><a href="#contributors-"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-57-orange.svg?style=flat-square" /></a></p>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<p align="center">
<a href="https://www.buymeacoffee.com/frankie567"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=frankie567&button_colour=FF5F5F&font_colour=ffffff&font_family=Arial&outline_colour=000000&coffee_colour=FFDD00"></a>
@@ -1392,6 +1392,10 @@
<td align="center"><a href="https://github.com/jtv8"><img src="https://avatars.githubusercontent.com/u/29302451?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joe Taylor</b></sub></a><br /><a href="https://github.com/fastapi-users/fastapi-users/commits?author=jtv8" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/ricfri"><img src="https://avatars.githubusercontent.com/u/21967765?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Richard Friberg</b></sub></a><br /><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Aricfri" title="Bug reports">🐛</a></td>
<td align="center"><a href="http://www.kentonparton.com"><img src="https://avatars.githubusercontent.com/u/20202312?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kenton Parton</b></sub></a><br /><a href="#financial-KentonParton" title="Financial">💵</a></td>
<td align="center"><a href="https://github.com/Qwizi"><img src="https://avatars.githubusercontent.com/u/23024321?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adrian Ciołek</b></sub></a><br /><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3AQwizi" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://blog.obscuritylabs.com"><img src="https://avatars.githubusercontent.com/u/8761706?v=4?s=100" width="100px;" alt=""/><br /><sub><b>⭕Alexander Rymdeko-Harvey</b></sub></a><br /><a href="https://github.com/fastapi-users/fastapi-users/commits?author=killswitch-GUI" title="Documentation">📖</a></td>
</tr>
</table>

34
10.0/installation/index.html
View File

@@ -308,6 +308,20 @@
With Beanie support
</a>
</li>
<li class="md-nav__item">
<a href="#with-redis-authentication-backend-support" class="md-nav__link">
With Redis authentication backend support
</a>
</li>
<li class="md-nav__item">
<a href="#with-oauth2-support" class="md-nav__link">
With OAuth2 support
</a>
</li>
</ul>
@@ -1141,6 +1155,20 @@
With Beanie support
</a>
</li>
<li class="md-nav__item">
<a href="#with-redis-authentication-backend-support" class="md-nav__link">
With Redis authentication backend support
</a>
</li>
<li class="md-nav__item">
<a href="#with-oauth2-support" class="md-nav__link">
With OAuth2 support
</a>
</li>
</ul>
@@ -1163,8 +1191,12 @@
<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[sqlalchemy]&#39;</span>
</code></pre></div>
<h2 id="with-beanie-support">With Beanie support<a class="headerlink" href="#with-beanie-support" 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>pip install <span class="s1">&#39;fastapi-users[mongodb]&#39;</span>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>pip install <span class="s1">&#39;fastapi-users[beanie]&#39;</span>
</code></pre></div>
<h2 id="with-redis-authentication-backend-support">With Redis authentication backend support<a class="headerlink" href="#with-redis-authentication-backend-support" title="Permanent link">&para;</a></h2>
<p>Information on installing with proper database support can be found in the <a href="../configuration/authentication/strategies/redis/">Redis</a> section.</p>
<h2 id="with-oauth2-support">With OAuth2 support<a class="headerlink" href="#with-oauth2-support" title="Permanent link">&para;</a></h2>
<p>Information on installing with proper database support can be found in the <a href="../configuration/oauth/">OAuth2</a> section.</p>
<hr />
<p>That's it! In the next section, we'll have an <a href="../configuration/overview/">overview</a> of how things work.</p>

2
10.0/search/search_index.json
View File

File diff suppressed because one or more lines are too long

72
10.0/sitemap.xml
View File

@@ -2,182 +2,182 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2022-05-06</lastmod>
<lastmod>2022-05-10</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
10.0/sitemap.xml.gz
View File

Binary file not shown.