lsm/openiddict-documentation
1
0
Fork 0
mirror of https://gitee.com/dcren/openiddict-documentation.git synced 2026-04-16 02:38:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update the documentation pages

Browse Source
This commit is contained in:
OpenIddict Bot
2023-05-02 19:58:39 +00:00
parent 55127dcfe7
commit ea52e730fc
160 changed files with 9194 additions and 5001 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
integrations/mongodb.html
View File

@@ -2,15 +2,15 @@
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>MongoDB integration </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="MongoDB integration ">
<meta name="generator" content="docfx ">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/night-owl.min.css">
@@ -19,9 +19,9 @@
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body>
@@ -31,7 +31,7 @@
<svg name="Hamburger" style="vertical-align: middle;" width="24" height="24" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
</a>
<a class="brand" href="../index.html">
<img src="../images/logo.png" alt="OpenIddict" class="logomark">
<span class="brand-title">OpenIddict</span>
@@ -46,25 +46,25 @@
<div class="sidebar">
<div>
<a class="brand" href="../index.html">
<img src="../images/logo.png" alt="OpenIddict" class="logomark">
<span class="brand-title">OpenIddict</span>
</a>
<div id="navbar">
</div>
</div>
<div class="sidebar-item-separator"></div>
<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
@@ -72,8 +72,8 @@
</div>
<div class="footer">
<span>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</nav>
@@ -81,7 +81,7 @@
<div role="main" class="hide-when-search">
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
@@ -94,12 +94,11 @@
<h1 id="mongodb-integration">MongoDB integration</h1>
<h2 id="basic-configuration">Basic configuration</h2>
<p>To configure OpenIddict to use MongoDB as the database for applications, authorizations, scopes and tokens, you'll need to:</p>
<p>To configure OpenIddict to use MongoDB as the database for applications, authorizations, scopes and tokens, you&#39;ll need to:</p>
<ul>
<li><p><strong>Reference the <code>OpenIddict.MongoDb</code> package</strong>:</p>
<pre><code class="lang-xml">&lt;PackageReference Include=&quot;OpenIddict.MongoDb&quot; Version=&quot;3.1.1&quot; /&gt;
</code></pre>
</li>
</code></pre></li>
<li><p><strong>Configure OpenIddict to use the MongoDB stores</strong>:</p>
<pre><code class="lang-csharp">services.AddOpenIddict()
.AddCore(options =&gt;
@@ -109,8 +108,7 @@
options.UseMongoDb()
.UseDatabase(new MongoClient().GetDatabase(&quot;openiddict&quot;));
});
</code></pre>
<p>Alternatively, you can register the <code>IMongoDatabase</code> instance as a service:</p>
</code></pre><p>Alternatively, you can register the <code>IMongoDatabase</code> instance as a service:</p>
<pre><code class="lang-csharp">services.AddOpenIddict()
.AddCore(options =&gt;
{
@@ -120,8 +118,7 @@
// Note: to use a remote server, call the MongoClient constructor overload
// that accepts a connection string or an instance of MongoClientSettings.
services.AddSingleton(new MongoClient().GetDatabase(&quot;shared-database-instance&quot;));
</code></pre>
</li>
</code></pre></li>
<li><p><strong>Create indexes to improve performance</strong> (recommended): for that, you can use the following script to
initialize the database and create the indexes used by the OpenIddict entities:</p>
<pre><code class="lang-csharp">using System.Threading;
@@ -217,8 +214,7 @@ await tokens.Indexes.CreateManyAsync(new[]
Background = true
})
});
</code></pre>
</li>
</code></pre></li>
</ul>
<h2 id="advanced-configuration">Advanced configuration</h2>
<h3 id="use-custom-entities">Use custom entities</h3>
@@ -244,8 +240,7 @@ public class CustomToken : OpenIddictMongoDbToken
{
public string CustomProperty { get; set; }
}
</code></pre>
</li>
</code></pre></li>
<li><p><strong>Configure MongoDb to use the custom entities</strong>:</p>
<pre><code class="lang-csharp">services.AddOpenIddict()
.AddCore(options =&gt;
@@ -256,8 +251,7 @@ public class CustomToken : OpenIddictMongoDbToken
.ReplaceDefaultScopeEntity&lt;CustomScope&gt;()
.ReplaceDefaultTokenEntity&lt;CustomToken&gt;();
});
</code></pre>
</li>
</code></pre></li>
</ul>
<h3 id="use-custom-collection-names">Use custom collection names</h3>
<p>By default, OpenIddict uses the <code>openiddict.[entity name]s</code> pattern to determine the default collection names.
@@ -271,23 +265,22 @@ Applications that require using different collection names can use the <code>Set
.SetScopesCollectionName(&quot;custom-scopes-collection&quot;)
.SetTokensCollectionName(&quot;custom-tokens-collection&quot;);
});
</code></pre>
</article>
</code></pre></article>
</div>
</main>
</div>
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
<script type="text/javascript" src="../styles/url.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
<script type="text/javascript" src="../styles/url.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>