Skip to content

Commit 740a664

Browse files
committed
add a more valid description to the development
1 parent 4ceb5ba commit 740a664

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# KK.AspNetCore.EasyAuthAuthentication
22

3-
This helps getting azure appservice authentication working with asp.net core.
3+
This helps getting azure appservice authentication working with asp.net core.
44

55
## NuGet
66

@@ -22,7 +22,7 @@ There are also access to packages from pull requests in another <a href="https:/
2222

2323
## Build
2424

25-
The build environment for this project is on Azure DevOps and can be found here [dev.azure.com/kirkone/KK.AspNetCore.EasyAuthAuthentication](https://dev.azure.com/kirkone/KK.AspNetCore.EasyAuthAuthentication/_build).
25+
The build environment for this project is on Azure DevOps and can be found here [dev.azure.com/kirkone/KK.AspNetCore.EasyAuthAuthentication](https://dev.azure.com/kirkone/KK.AspNetCore.EasyAuthAuthentication/_build).
2626

2727
### Nuget package build
2828

@@ -136,7 +136,7 @@ The `NameClaimType` is the ClaimType of the value which one will be used to fill
136136

137137
#### Local Debugging
138138

139-
For debugging your application you can place a `me.json` in the `wwwroot/.auth` folder of your web app and add some configuration to the `AddEasyAuth` call.
139+
For debugging your application you can place a `me.json` in the `wwwroot/.auth` folder of your web app and add some configuration to the `AddEasyAuth` call.
140140
For example:
141141

142142
```csharp
@@ -161,13 +161,18 @@ For example:
161161

162162
There are some predefined providers in this package. If you need your own or want contribute to our existing providers you must implement the `IEasyAuthAuthentificationService`.
163163

164-
### `EasyAuthWithAuthMeService` (always on)
164+
### `EasyAuthWithAuthMeService`
165165

166-
This is a slightly special provider. This provider cannot be configured and does not implement the 'IEasyAuthAuthentificationService'. This provider is for development. A developer can create a JSON with the content of the `/.auth/me` endpoint of an EasyAuth Azure Web App. So you don't need a connection to the internet or azure for development and just use your local things.
166+
This is a slightly special provider. This provider cannot be configured. You can only turn it on or off. It also does **not** implement the 'IEasyAuthAuthentificationService'. This provider is for development. A developer can create a JSON with the content of the `/.auth/me` endpoint of an EasyAuth Azure Web App. So you don't need a connection to the internet or azure for development and just use your local things.
167+
You must only configure an Azure Web App with Authentification and browse the path:
168+
169+
`https://hostnameOfYourWebSite/.auth/me`
170+
171+
This endpoint return a json after the authentication. Put the content in a new file in your `wwwroot`folder. (create the same path like: `.auth/me.json`)
167172

168173
### `EasyAuthForAuthorizationTokenService`
169174

170-
Use this provider if you have a Azure Web App, that is not only be used by humans. For instance if you want to access your app with a Service Principal (SPN).
175+
Use this provider if you have a Azure Web App, that is not only be used by humans. For instance if you want to access your app with a Service Principal (SPN).
171176

172177
To create a Service Principal (SPN), which get access to your EasyAuth protected Application. You have to change the app manifest for you application in your Azure AD. Thanks to [Suzuko123](https://github.com/Suzuko123) for the following sample:
173178

@@ -206,7 +211,7 @@ See also the list of [contributors](https://github.com/kirkone/KK.AspNetCore.Eas
206211

207212
## License
208213

209-
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
214+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
210215

211216
## Acknowledgments
212217

0 commit comments

Comments
 (0)