FyinDotCom.AccessCode.AspNetCore
6.2.0
dotnet add package FyinDotCom.AccessCode.AspNetCore --version 6.2.0
NuGet\Install-Package FyinDotCom.AccessCode.AspNetCore -Version 6.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FyinDotCom.AccessCode.AspNetCore" Version="6.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FyinDotCom.AccessCode.AspNetCore --version 6.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FyinDotCom.AccessCode.AspNetCore, 6.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FyinDotCom.AccessCode.AspNetCore as a Cake Addin #addin nuget:?package=FyinDotCom.AccessCode.AspNetCore&version=6.2.0 // Install FyinDotCom.AccessCode.AspNetCore as a Cake Tool #tool nuget:?package=FyinDotCom.AccessCode.AspNetCore&version=6.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
- Add the following json object to the appsettings.json file...
"AccessCodeSettings": {
"Enable": "true", // true|false, Optional Default: true
"AccessCode": "fyin", // Required
"CheckWhiteListedIpAddresses": "false", // Required
"WhiteListedIpAddresses": [
"127.0.0.1",
"::1",
"::2"
], // Required if you're checking whitelisted ip addresses.
"IgnoredPaths": [
"^/api/",
"^/assets/"
], // Include if you want certain paths to be ignored (regex pattern)
"SplashImagePathOrUrl" : "splashImagePathOrUrl" // Optional
// SplashImagePathOrUrl: If left empty it will use the blue bird denver image.else,
// If image is hosted somewhere specify full url path.
// If hosted in project then just give relative wwwroot path.
// For example "/images/AccessCodeImage.jpg"
}
- Add the following lines of code to the ConfigureServices method...
services.AddSession(); // add session
services.Configure<AccessCodeSettings>(options => Configuration.GetSection("AccessCodeSettings").Bind(options));
services.AddHttpContextAccessor();
services.AddTransient<IAccessCodeRequestValidationService, AccessCodeRequestValidationService>();
services.AddTransient<IAccessCodeCookieService, AccessCodeCookieService>();
- Add the following lines of code to the Configure method...
//Remove this line when you want full production live without access code functionality.
app.UseSession().UseAccessCodeMiddleware();
General Notes
If you want to disable the accesscode check without an app restart, then just delete the AccessCode.html
file in your project.
If you can do an app-restart or deployment, then just remove the line of code in #3.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- HtmlAgilityPack (>= 1.11.53)
- Microsoft.Extensions.DependencyInjection (>= 6.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.4)
- Microsoft.Extensions.Options (>= 6.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on FyinDotCom.AccessCode.AspNetCore:
Package | Downloads |
---|---|
FyinDotCom.AccessCode.Umbraco
A .net 6 targeted middleware that will render a passcode secured page to block access to a site until the correct passcode is entered. |
GitHub repositories
This package is not used by any popular GitHub repositories.