Judah Himango CW
53 lines
2.3 KiB
Markdown
53 lines
2.3 KiB
Markdown
# <img src="https://github.com/JudahGabriel/RavenDB.Identity/blob/master/RavenDB.Identity/nuget-icon.png?raw=true" width="50px" height="50px" /> RavenDB.Identity
|
|
The simple and easy Identity provider for RavenDB and ASP.NET Core. Use Raven to store your users and logins.
|
|
|
|
## Instructions ##
|
|
1. Add an [AppUser class](https://github.com/JudahGabriel/RavenDB.Identity/blob/master/Sample/Models/AppUser.cs) that derives from Raven.Identity.IdentityUser:
|
|
```csharp
|
|
public class AppUser : Raven.Identity.IdentityUser
|
|
{
|
|
/// <summary>
|
|
/// A user's full name.
|
|
/// </summary>
|
|
public string FullName { get; set; }
|
|
}
|
|
```
|
|
|
|
2. In appsettings.json, configure your connection to Raven:
|
|
|
|
```json
|
|
"RavenSettings": {
|
|
"Urls": [
|
|
"http://live-test.ravendb.net"
|
|
],
|
|
"DatabaseName": "Raven.Identity.Sample",
|
|
"CertFilePath": "",
|
|
"CertPassword": ""
|
|
},
|
|
```
|
|
|
|
3. In [Startup.cs](https://github.com/JudahGabriel/RavenDB.Identity/blob/master/Sample/Startup.cs), wire it all up:
|
|
|
|
```csharp
|
|
public void ConfigureServices(IServiceCollection services)
|
|
{
|
|
// Grab our RavenSettings object from appsettings.json.
|
|
services.Configure<RavenSettings>(Configuration.GetSection("RavenSettings"));
|
|
|
|
...
|
|
|
|
// Add RavenDB and identity.
|
|
services
|
|
.AddRavenDbDocStore() // Create an IDocumentStore singleton from the RavenSettings.
|
|
.AddRavenDbAsyncSession() // Create a RavenDB IAsyncDocumentSession for each request. You're responsible for calling .SaveChanges after each request.
|
|
.AddRavenDbIdentity<AppUser>(); // Use Raven to manage users and roles.
|
|
|
|
...
|
|
}
|
|
```
|
|
|
|
4. In your controller actions, [call .SaveChangesAsync() when you're done making changes](https://github.com/JudahGabriel/RavenDB.Identity/blob/master/Sample/Filters/RavenSaveChangesAsyncFilter.cs#L35). Typically this is done via a RavenController base class for MVC/WebAPI projects or via an action filter. See our sample [RavenSaveChangesAsyncFilter.cs](https://github.com/JudahGabriel/RavenDB.Identity/blob/master/Sample/Filters/RavenSaveChangesAsyncFilter.cs).
|
|
|
|
Need help? Checkout the [sample app](https://github.com/JudahGabriel/RavenDB.Identity/tree/master/Sample) to see it all in action.
|
|
|
|
Not using .NET Core? See our [sister project](https://github.com/JudahGabriel/RavenDB.AspNet.Identity) for a RavenDB Identity Provider for the full .NET Framework. |