FyinDotCom.AccessCode.Umbraco 6.2.0

dotnet add package FyinDotCom.AccessCode.Umbraco --version 6.2.0
NuGet\Install-Package FyinDotCom.AccessCode.Umbraco -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.Umbraco" 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.Umbraco --version 6.2.0
#r "nuget: FyinDotCom.AccessCode.Umbraco, 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.Umbraco as a Cake Addin
#addin nuget:?package=FyinDotCom.AccessCode.Umbraco&version=6.2.0

// Install FyinDotCom.AccessCode.Umbraco as a Cake Tool
#tool nuget:?package=FyinDotCom.AccessCode.Umbraco&version=6.2.0
  1. Add u.AppBuilder.UseAccessCodeMiddleware() to app.UseUmbraco().WithMiddleware() in the the Configure method of your Startup.cs.
    app.UseUmbraco()
        .WithMiddleware(u =>
        {
            u.UseBackOffice();
            u.UseWebsite();   
            u.AppBuilder.UseAccessCodeMiddleware(); <== Add this to WithMiddleware 
        })
        .WithEndpoints(u =>
        {
            u.UseInstallerEndpoints();
            u.UseBackOfficeEndpoints();
            u.UseWebsiteEndpoints();
        });
  1. Build & run the solution to complete the install.
  2. After building you can modify the AccessCode.html at the root of the project to customs as needed.

General Notes

As a reference, this package will add the following values to appsettings.json file...

    "AccessCodeSettings": {
        "Enable": "true", // true|false, Optional Default: true
        "AccessCode": "opensaysme", //required
        "CheckWhiteListedIpAddresses": "true", // Required. Set to false if you want to test the access code page locally. 
        "WhiteListedIpAddresses": [
            "127.0.0.1",
            "::1",
            "::2"
        ], // Required if CheckWhiteListedIpAddresses is true.
        "IgnoredPaths": [
            "^/api/",
            "^/assets/"
        ], // Include if you want certain paths to be ignored (regex pattern).
        "SplashImagePathOrUrl" : "splashImagePathOrUrl" // Optional. If image is hosted somewhere else, specify full url path.  If hosted in project then just give relative wwwroot path.  For example "/images/AccessCodeImage.jpg"   
        "Debug": "false" // Optional. When set to true, logging is more verbose and some error handle is disable and will throw errors. 
        }

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 / deploy then just remove the line of code in #2

Product 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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.2.0 792 11/6/2023
6.1.6 113 10/12/2023
6.1.5 281 10/12/2023
6.1.4 126 10/9/2023
6.1.3 100 10/9/2023
6.1.2 124 10/6/2023