How does one implement AutoSetup when using a Decoupled CMS Site? #16249

ccnicholls99 · 2024-06-05T16:00:53Z

ccnicholls99
Jun 5, 2024

I created a decoupled CMS Site using the instructions here: https://docs.orchardcore.net/en/latest/guides/decoupled-cms/ - up to the point of creating any content.

I then followed the instructions here: https://docs.orchardcore.net/en/latest/reference/modules/AutoSetup/, (and related Setup instructions) to add the settings to Auto-Setup my Default Tenant.

My startup code looks like this...
builder.Services.AddOrchardCms().AddSetupFeatures("OrchardCore.AutoSetup");
...and the Auto-Setup values are in appsettings.json

On running the webapp, the Auto-Setup is never triggered. It always shows the Setup screen.

I suspect I probably need to enable one or more features in Program.cs but which ones? I have tried a few combinations but either the setup screen appears or I get exceptions before Setup screen is rendered.

hishamco · 2024-06-05T18:02:12Z

hishamco
Jun 5, 2024
Maintainer

Try the following

services .AddOrchardCms(builder => builder.AddSetupFeatures("OrchardCore.AutoSetup"))

as it's shown in https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/blob/main/src/OrchardCoreContrib.Modules.Web/Startup.cs

Otherwise, I need to check because I saw a strange behavior in the last two weeks when I was using AutoSetup in another project

5 replies

ccnicholls99 Jun 5, 2024
Author

Thanks for the response but that makes no difference.

hishamco Jun 6, 2024
Maintainer

Which OC version are you using?

ccnicholls99 Jun 6, 2024
Author

1.8.3

ccnicholls99 Jun 6, 2024
Author

Following along with the current docs as published.

hishamco Jun 6, 2024
Maintainer

According to your comment here it's a typo or a real bug?

Piedone · 2024-06-05T20:47:34Z

Piedone
Jun 5, 2024
Maintainer

What you show should work, so I suspect something is incorrectly configured in the appsettings, or there's some error running it.

What's in your appsettings? Do you see anything in the logs?

10 replies

ccnicholls99 Jun 6, 2024
Author

I have a recipe (see Custom Recipe, below) that I originally exported after setting up the Default tenant manually, with all the Features I needed. If I include that recipe in the AutoSetup, I get an exception (see EX1 below).

I figured, perhaps the custom recipe was incorrectly configured, so I went back and substituted my custom recipe for 'Blank', and 'Saas' as well. Neither solution worked. When I run the app, I still get the SETUP screen.

(EX1)

(Custom Recipe)

{
  "name": "blah.setup",
  "displayName": "blah Setup",
  "description": "Site Establishment for blah",
  "author": "blah",
  "website": "https://blah.blah.com",
  "version": "1.0.0",
  "issetuprecipe": true,
  "categories": [
    "blah",
    " admin"
  ],
  "tags": [
    "blah",
    " setup"
  ],
  "steps": [
    {
      "name": "Settings",
      "AdminSettings": {
        "DisplayThemeToggler": true,
        "DisplayMenuFilter": true,
        "DisplayNewMenu": true,
        "DisplayTitlesInTopbar": true
      },
      "LoginSettings": {
        "UseSiteTheme": false,
        "UseExternalProviderIfOnlyOneDefined": false,
        "DisableLocalLogin": false,
        "UseScriptToSyncRoles": false,
        "SyncRolesScript": null,
        "AllowChangingUsername": false,
        "AllowChangingEmail": false,
        "AllowChangingPhoneNumber": true
      },
      "RegistrationSettings": {
        "UsersCanRegister": 1,
        "UsersMustValidateEmail": true,
        "UsersAreModerated": true,
        "UseSiteTheme": false,
        "NoPasswordForExternalUsers": false,
        "NoUsernameForExternalUsers": false,
        "NoEmailForExternalUsers": false,
        "UseScriptToGenerateUsername": false,
        "GenerateUsernameScript": "/* Uncomment to map AzureAd\r\n// Uncomment to output the context variable in the logs\r\n// log(\"warning\", JSON.stringify(context));\r\nswitch (context.loginProvider) {\r\n    case \"AzureAd\":\r\n        context.userName = \"azad\" + uuid();\r\n        break;\r\n    default:\r\n        log(\"Warning\", \"Provider \" + context.loginProvider + \" was not handled\");\r\n        // Uncomment to generate a username as a uuid\r\n        // context.userName = \"u\" + uuid();\r\n        break;\r\n}\r\n*/\r\n"
      }
    },
    {
      "name": "Feature",
      "enable": [
        "Application.Default",
        "blah.Web",
        "OrchardCore.Settings",
        "OrchardCore.Admin",
        "OrchardCore.Liquid",
        "OrchardCore.Contents",
        "OrchardCore.ContentTypes",
        "OrchardCore.Shortcodes",
        "OrchardCore.Html",
        "OrchardCore.Recipes.Core",
        "OrchardCore.Title",
        "OrchardCore.Templates",
        "OrchardCore.AdminTemplates",
        "OrchardCore.Alias",
        "OrchardCore.Autoroute",
        "OrchardCore.Scripting",
        "OrchardCore.Recipes",
        "OrchardCore.ContentFields",
        "OrchardCore.Roles.Core",
        "OrchardCore.Users",
        "OrchardCore.Sitemaps",
        "OrchardCore.ContentPreview",
        "OrchardCore.Deployment",
        "OrchardCore.CustomSettings",
        "OrchardCore.Deployment.Remote",
        "OrchardCore.Diagnostics",
        "OrchardCore.DynamicCache",
        "OrchardCore.Resources",
        "OrchardCore.Email",
        "OrchardCore.Widgets",
        "OrchardCore.Features",
        "OrchardCore.Feeds",
        "OrchardCore.Flows",
        "OrchardCore.Forms",
        "OrchardCore.HomeRoute",
        "OrchardCore.Https",
        "OrchardCore.Indexing",
        "OrchardCore.Rules",
        "OrchardCore.Layers",
        "OrchardCore.Lists",
        "OrchardCore.Markdown",
        "OrchardCore.Media",
        "OrchardCore.Media.Cache",
        "OrchardCore.Media.AmazonS3",
        "OrchardCore.Media.Azure.Storage",
        "OrchardCore.Menu",
        "OrchardCore.Navigation",
        "OrchardCore.Notifications",
        "OrchardCore.Notifications.Email",
        "OrchardCore.Sms",
        "OrchardCore.Notifications.Sms",
        "OrchardCore.Placements",
        "OrchardCore.Placements.FileStorage",
        "OrchardCore.Queries",
        "OrchardCore.ReCaptcha",
        "OrchardCore.ReCaptcha.Users",
        "OrchardCore.Roles",
        "OrchardCore.Security",
        "OrchardCore.Seo",
        "OrchardCore.Shortcodes.Templates",
        "OrchardCore.Sitemaps.Cleanup",
        "OrchardCore.Sitemaps.RazorPages",
        "OrchardCore.Tenants",
        "OrchardCore.Tenants.FeatureProfiles",
        "OrchardCore.Tenants.FileProvider",
        "OrchardCore.Themes",
        "OrchardCore.Users.Registration",
        "OrchardCore.Users.ResetPassword",
        "TheAdmin"
      ],
      "disable": [
        "OrchardCore.AdminDashboard",
        "OrchardCore.AdminMenu",
        "OrchardCore.Apis.GraphQL",
        "OrchardCore.ArchiveLater",
        "OrchardCore.AuditTrail",
        "OrchardCore.Setup",
        "OrchardCore.AutoSetup",
        "OrchardCore.BackgroundTasks",
        "OrchardCore.ContentFields.Indexing.SQL",
        "OrchardCore.ContentFields.Indexing.SQL.UserPicker",
        "OrchardCore.Localization",
        "OrchardCore.ContentLocalization",
        "OrchardCore.ContentLocalization.ContentCulturePicker",
        "OrchardCore.ContentLocalization.Sitemaps",
        "OrchardCore.Contents.Deployment.AddToDeploymentPlan",
        "OrchardCore.Contents.Deployment.Download",
        "OrchardCore.Contents.Deployment.ExportContentToDeploymentTarget",
        "OrchardCore.Contents.FileContentDefinition",
        "OrchardCore.Cors",
        "OrchardCore.DataProtection.Azure",
        "OrchardCore.Facebook",
        "OrchardCore.Facebook.Login",
        "OrchardCore.Facebook.Pixel",
        "OrchardCore.Facebook.Widgets",
        "OrchardCore.GitHub.Authentication",
        "OrchardCore.Google.Analytics",
        "OrchardCore.Google.GoogleAuthentication",
        "OrchardCore.Google.TagManager",
        "OrchardCore.HealthChecks",
        "OrchardCore.Localization.AdminCulturePicker",
        "OrchardCore.Localization.ContentLanguageHeader",
        "OrchardCore.Media.Indexing",
        "OrchardCore.Media.Slugify",
        "OrchardCore.Microsoft.Authentication.AzureAD",
        "OrchardCore.Microsoft.Authentication.MicrosoftAccount",
        "OrchardCore.MiniProfiler",
        "OrchardCore.OpenId",
        "OrchardCore.OpenId.Client",
        "OrchardCore.OpenId.Management",
        "OrchardCore.OpenId.Server",
        "OrchardCore.OpenId.Validation",
        "OrchardCore.PublishLater",
        "OrchardCore.Queries.Sql",
        "OrchardCore.Redis",
        "OrchardCore.Redis.Bus",
        "OrchardCore.Redis.Cache",
        "OrchardCore.Redis.DataProtection",
        "OrchardCore.Redis.Lock",
        "OrchardCore.XmlRpc",
        "OrchardCore.RemotePublishing",
        "OrchardCore.ResponseCompression",
        "OrchardCore.ReverseProxy",
        "OrchardCore.Search",
        "OrchardCore.Search.Elasticsearch",
        "OrchardCore.Search.Elasticsearch.ContentPicker",
        "OrchardCore.Search.Elasticsearch.Worker",
        "OrchardCore.Search.Lucene",
        "OrchardCore.Search.Lucene.ContentPicker",
        "OrchardCore.Search.Lucene.Worker",
        "OrchardCore.Spatial",
        "OrchardCore.Taxonomies",
        "OrchardCore.Taxonomies.ContentsAdminList",
        "OrchardCore.Tenants.Distributed",
        "OrchardCore.Twitter",
        "OrchardCore.Twitter.Signin",
        "OrchardCore.Users.2FA",
        "OrchardCore.Users.2FA.AuthenticatorApp",
        "OrchardCore.Users.2FA.Email",
        "OrchardCore.Users.2FA.Sms",
        "OrchardCore.Users.AuditTrail",
        "OrchardCore.Users.Authentication.CacheTicketStore",
        "OrchardCore.Users.ChangeEmail",
        "OrchardCore.Users.CustomUserSettings",
        "OrchardCore.Users.TimeZone",
        "OrchardCore.Workflows",
        "OrchardCore.Workflows.Http",
        "OrchardCore.Workflows.Session",
        "OrchardCore.Workflows.Timers"
      ]
    },
    {
      "name": "Settings",
      "BaseUrl": null,
      "Calendar": null,
      "MaxPagedCount": 0,
      "MaxPageSize": 100,
      "PageSize": 10,
      "TimeZoneId": "America/Lower_Princes",
      "ResourceDebugMode": 0,
      "SiteName": "Blah Blah",
      "SiteSalt": "c9faf85f6a01461884cb5d4059fa3371",
      "PageTitleFormat": "{% page_title Site.SiteName, position: \"after\", separator: \" - \" %}",
      "SuperUser": "4s8nyc7jg1jpe2fs65gnrs8tnx",
      "UseCdn": false,
      "CdnBaseUrl": null,
      "HomeRoute": {},
      "AppendVersion": true,
      "CacheMode": 0
    },
    {
      "name": "deployment",
      "Plans": [
        {
          "Name": "blah Setup",
          "Steps": [
            {
              "Type": "RecipeFileDeploymentStep",
              "Step": {
                "RecipeName": "blah.setup",
                "DisplayName": "blah Setup",
                "Description": "Site Establishment for blah",
                "Author": "blah",
                "WebSite": "https://blah.blah.com",
                "Version": "1.0.0",
                "IsSetupRecipe": true,
                "Categories": "blah admin",
                "Tags": "blah setup",
                "Id": "26190bebb5014761b0ac4246c887f3ef",
                "Name": "RecipeFileDeploymentStep"
              }
            },
            {
              "Type": "AdminSettings_SiteSettingsPropertyDeploymentStep",
              "Step": {
                "Id": "c1973cfc531d4da09a36a19ffe8fdfa1",
                "Name": "AdminSettings_SiteSettingsPropertyDeploymentStep"
              }
            },
            {
              "Type": "AllFeaturesDeploymentStep",
              "Step": {
                "IgnoreDisabledFeatures": false,
                "Id": "f0f934f33d9542a8a457e4799fa79fe0",
                "Name": "AllFeatures"
              }
            },
            {
              "Type": "SiteSettingsDeploymentStep",
              "Step": {
                "Settings": [
                  "BaseUrl",
                  "Calendar",
                  "MaxPagedCount",
                  "MaxPageSize",
                  "PageSize",
                  "TimeZoneId",
                  "ResourceDebugMode",
                  "SiteName",
                  "SiteSalt",
                  "PageTitleFormat",
                  "SuperUser",
                  "UseCdn",
                  "CdnBaseUrl",
                  "HomeRoute",
                  "AppendVersion",
                  "CacheMode"
                ],
                "Id": "01c70d0c004d41b98506c2412ebaa190",
                "Name": "SiteSettings"
              }
            },
            {
              "Type": "LoginSettings_SiteSettingsPropertyDeploymentStep",
              "Step": {
                "Id": "db7063a404764f8aa7f60518090c185d",
                "Name": "LoginSettings_SiteSettingsPropertyDeploymentStep"
              }
            },
            {
              "Type": "DeploymentPlanDeploymentStep",
              "Step": {
                "IncludeAll": true,
                "DeploymentPlanNames": [],
                "Id": "c9cebe5a7d944a9cbaca090927b3e3eb",
                "Name": "DeploymentPlan"
              }
            },
            {
              "Type": "ThemesDeploymentStep",
              "Step": {
                "Id": "556ba11a534643239c2a41b7cfdede0e",
                "Name": "Themes"
              }
            },
            {
              "Type": "RegistrationSettings_SiteSettingsPropertyDeploymentStep",
              "Step": {
                "Id": "aa016264f70a4cf5b23bc6b1057201ee",
                "Name": "RegistrationSettings_SiteSettingsPropertyDeploymentStep"
              }
            },
            {
              "Type": "AllRolesDeploymentStep",
              "Step": {
                "Id": "303e53f40fa1432c835f31ca6321e372",
                "Name": "AllRoles"
              }
            }
          ]
        }
      ]
    },
    {
      "name": "Themes",
      "Site": null,
      "Admin": "TheAdmin"
    },
    {
      "name": "Roles",
      "Roles": [
        {
          "Name": "Administrator",
          "Description": "Administrator",
          "Permissions": [
            "ManageShortcodeTemplates",
            "ManageSettings",
            "AccessAdminPanel",
            "ManageAdminSettings",
            "PublishContent",
            "EditContent",
            "DeleteContent",
            "PreviewContent",
            "CloneContent",
            "AccessContentApi",
            "ListContent",
            "EditContentOwner",
            "ViewContentTypes",
            "EditContentTypes",
            "ManageTemplates",
            "ManageAdminTemplates",
            "SetHomepage",
            "ManageUsers",
            "View Users",
            "ManageOwnUserInformation",
            "ListUsers",
            "EditUsers",
            "DeleteUsers",
            "AssignRoleToUsers",
            "Import",
            "Export",
            "ManageRemoteInstances",
            "ManageRemoteClients",
            "ExportRemoteInstances",
            "ManageFeatures",
            "ManageLayers",
            "ManageMediaFolder",
            "ManageMediaProfiles",
            "ViewMediaOptions",
            "ManageMenu",
            "ManageQueries",
            "ManageRoles",
            "SiteOwner",
            "ManageSecurityHeadersSettings",
            "ApplyTheme",
            "ManageTenants",
            "ManageTenantFeatureProfiles",
            "ManageSitemaps",
            "ManageSeoSettings",
            "ManagePlacements",
            "ViewAmazonS3MediaOptions",
            "ViewAzureMediaOptions",
            "ManageEmailSettings",
            "ManageNotifications",
            "ManageSmsSettings",
            "ManageHttps",
            "ManageReCaptchaSettings"
          ]
        },
        {
          "Name": "Authenticated",
          "Description": "Authenticated",
          "Permissions": [
            "ViewContent",
            "ManageNotifications"
          ]
        },
        {
          "Name": "Anonymous",
          "Description": "Anonymous",
          "Permissions": [
            "ViewContent"
          ]
        },
        {
          "Name": "blah Administrator",
          "Description": "Administration Role for blah Users",
          "Permissions": [
            "AssignRole_blah Administrator",
            "AssignRole_blah Employee",
            "AssignRole_blah Office",
            "ManageOwnUserInformation",
            "EditUsersInRole_blah Administrator",
            "EditUsersInRole_blah Employee",
            "EditUsersInRole_blah Office",
            "ListUsersInRole_blah Administrator",
            "ListUsersInRole_blah Employee",
            "ListUsersInRole_blah Office"
          ]
        },
        {
          "Name": "blah Office",
          "Description": "Back Office Role for blah Users",
          "Permissions": [
            "AssignRoleToUsers_blah Employee",
            "AssignRoleToUsers_blah Office",
            "ManageOwnUserInformation",
            "EditUsersInRole_blah Employee",
            "ListUsersInRole_blah Employee",
            "ListUsersInRole_blah Office",
            "ManageUsersInRole_blah Employee"
          ]
        },
        {
          "Name": "blah Employee",
          "Description": "Employee Role for blah Users",
          "Permissions": [
            "ManageOwnUserInformation",
            "ListUsersInRole_blah Employee"
          ]
        }
      ]
    }
  ]
}

Piedone Jun 6, 2024
Maintainer

What's in the log when you use the Blank recipe? The exception on your screenshot is somewhere very deep in .NET and not really helpful.

ccnicholls99 Jun 7, 2024
Author

Well, some success. I added Serilog to the app, blew away App_Data folder and retried using the Blank recipe. This time it worked and Auto Setup kicked in. (Using Both Sqlite and SqlConnection)

However,
Next I copied the Blank recipe to a folder in my project...
./Recipes/test.recipe.json

..then removed App_Data and updated appsettings.json and restarted. Start getting the exception again. It appears that autosetup cannot locate recipes in the webapp project. Am I missing something?

If NOT using auto setup, my custom recipes show up in the dropdown of the setup page.

Piedone Jun 7, 2024
Maintainer

What you're missing is showing the log despite me asking for it two times :).

ccnicholls99 Jun 7, 2024
Author

My apologies. My last message got truncated - the final paragraph where I mentioned I was away from my computer and would send the logs when I could get back online. Stand by...

ccnicholls99 · 2024-06-07T20:31:39Z

ccnicholls99
Jun 7, 2024
Author

Here is the log from running the webapp using a copy of the "Blank" recipe (./Recipes/test.recipe.json):\

2024-06-07 08:24:43.2080|||Microsoft.AspNetCore.DataProtection.KeyManagement.XmlKeyManager|INF|User profile is available. Using 'C:\Users\ccnic\AppData\Local\ASP.NET\DataProtection-Keys' as key repository and Windows DPAPI to encrypt keys at rest.
2024-06-07 08:24:43.5767|||Microsoft.Hosting.Lifetime|INF|Now listening on: https://localhost:5002
2024-06-07 08:24:43.5792|||Microsoft.Hosting.Lifetime|INF|Now listening on: http://localhost:5003
2024-06-07 08:24:43.5815|||Microsoft.Hosting.Lifetime|INF|Application started. Press Ctrl+C to shut down.
2024-06-07 08:24:43.5833|||Microsoft.Hosting.Lifetime|INF|Hosting environment: Development
2024-06-07 08:24:43.5874|||Microsoft.Hosting.Lifetime|INF|Content root path: C:\Users\ccnic\source\repos\Orchard\webapp\cboatops\source\Apps\CBoatOps.Web
2024-06-07 08:24:45.4594||0HN46TJ7S98E4:00000001|OrchardCore.Environment.Shell.ShellHost|INF|Start creation of shells
2024-06-07 08:24:47.3621||0HN46TJ7S98E4:00000001|OrchardCore.Environment.Shell.ShellHost|INF|Done pre-creating and registering shells
2024-06-07 08:24:47.4128|Default|0HN46TJ7S98E4:00000001|OrchardCore.Modules.ModularTenantRouterMiddleware|INF|Begin Routing Request
2024-06-07 08:24:47.8323|Default|0HN46TJ7S98E4:00000001|OrchardCore.AutoSetup.AutoSetupMiddleware|INF|AutoSetup is initializing the site
2024-06-07 08:24:47.8385|Default|0HN46TJ7S98E4:00000001|OrchardCore.Setup.Services.SetupService|INF|Running setup for tenant 'Default'.
2024-06-07 08:24:48.2208|Default|0HN46TJ7S98E4:00000001|OrchardCore.Environment.Shell.Data.Descriptors.ShellDescriptorManager|INF|Updating shell descriptor for tenant 'Default' ...
2024-06-07 08:24:48.2244|Default|0HN46TJ7S98E4:00000001|OrchardCore.Environment.Shell.Data.Descriptors.ShellDescriptorManager|INF|Shell descriptor updated for tenant 'Default'.
2024-06-07 08:25:14.6912||0HN46TJ7S98E4:00000001|Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware|ERR|An unhandled exception has occurred while executing the request.
System.NullReferenceException: Object reference not set to an instance of an object.
   at OrchardCore.Recipes.Services.RecipeExecutor.ExecuteAsync(String executionId, RecipeDescriptor recipeDescriptor, IDictionary`2 environment, CancellationToken cancellationToken)
   at OrchardCore.Recipes.Services.RecipeExecutor.ExecuteAsync(String executionId, RecipeDescriptor recipeDescriptor, IDictionary`2 environment, CancellationToken cancellationToken)
   at OrchardCore.Setup.Services.SetupService.SetupInternalAsync(SetupContext context)
   at OrchardCore.Setup.Services.SetupService.SetupInternalAsync(SetupContext context)
   at OrchardCore.Setup.Services.SetupService.SetupAsync(SetupContext context)
   at OrchardCore.Setup.Services.SetupService.SetupAsync(SetupContext context)
   at OrchardCore.AutoSetup.AutoSetupMiddleware.SetupTenantAsync(ISetupService setupService, TenantSetupOptions setupOptions, ShellSettings shellSettings)
   at OrchardCore.AutoSetup.AutoSetupMiddleware.InvokeAsync(HttpContext httpContext)
   at OrchardCore.AutoSetup.AutoSetupMiddleware.InvokeAsync(HttpContext httpContext)
   at Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware.Invoke(HttpContext context)
   at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
   at OrchardCore.Modules.ModularTenantRouterMiddleware.Invoke(HttpContext httpContext)
   at OrchardCore.Logging.SerilogTenantNameLoggingMiddleware.Invoke(HttpContext context)
   at OrchardCore.Modules.ModularTenantContainerMiddleware.<>c__DisplayClass4_0.<<Invoke>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at OrchardCore.Environment.Shell.Scope.ShellScope.UsingAsync(Func`2 execute, Boolean activateShell)
   at OrchardCore.Environment.Shell.Scope.ShellScope.UsingAsync(Func`2 execute, Boolean activateShell)
   at OrchardCore.Environment.Shell.Scope.ShellScope.UsingAsync(Func`2 execute, Boolean activateShell)
   at OrchardCore.Environment.Shell.Scope.ShellScope.UsingAsync(Func`2 execute, Boolean activateShell)
   at OrchardCore.Environment.Shell.Scope.ShellScope.UsingAsync(Func`2 execute, Boolean activateShell)
   at OrchardCore.Modules.ModularTenantContainerMiddleware.Invoke(HttpContext httpContext)
   at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddlewareImpl.Invoke(HttpContext context)

More Verbose log here:
orchard-log20240607.txt

1 reply

ccnicholls99 Jun 8, 2024
Author

Found the problem. See below.

ccnicholls99 · 2024-06-08T20:59:29Z

ccnicholls99
Jun 8, 2024
Author

Solved.
It came down to an incorrect RecipeName in appsettings.json (OrchardCore:OrchardCore_Setup:Tenants["ShellName"="Default"]:RecipeName)

I was mistakenly using the Recipe File Name prefix rather than the Name property listed in the recipe json. Apparently the recipe file name is immaterial, it is the "name" property in the recipe json file that is the key.

The documentation on Auto_Setup here: https://docs.orchardcore.net/en/latest/reference/modules/AutoSetup/, could be made a little more clear on this.

0 replies

ccnicholls99 · 2024-06-09T13:36:03Z

ccnicholls99
Jun 9, 2024
Author

In https://docs.orchardcore.net/en/latest/reference/modules/Recipes/...

You can add it in a Recipes folder with a name like this {RecipeName}.recipe.json and it will be available in the Configuration > Recipes admin page.
...alternately...
You can add it in a Recipes folder with a name like this {RecipeName}.recipe.json and it will be available in the Configuration > Recipes admin page. The Recipe is identified by the "Name" property in the Json file and uses the 'displayName' property when exposed in the Configuration UI. Note that Recipe "Name" property must be unique.

In https://docs.orchardcore.net/en/latest/reference/modules/AutoSetup/...
(RecipeName parameter description)...

The tenant installation Recipe name.
...alternately...
(Required) The Recipe (i.e. Recipe.Name) to be installed in the Tenant.

3 replies

Piedone Jun 9, 2024
Maintainer

Congrats on finding this! Would you venture into submitting a PR for improving the docs? See https://docs.orchardcore.net/en/latest/guides/contributing/contributing-documentation/.

ccnicholls99 Jun 9, 2024
Author

Sure.

Piedone Jun 10, 2024
Maintainer

Thank you!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How does one implement AutoSetup when using a Decoupled CMS Site? #16249

{{title}}

Replies: 5 comments 19 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

How does one implement AutoSetup when using a Decoupled CMS Site? #16249

ccnicholls99 Jun 5, 2024

Replies: 5 comments · 19 replies

hishamco Jun 5, 2024 Maintainer

ccnicholls99 Jun 5, 2024 Author

hishamco Jun 6, 2024 Maintainer

ccnicholls99 Jun 6, 2024 Author

ccnicholls99 Jun 6, 2024 Author

hishamco Jun 6, 2024 Maintainer

Piedone Jun 5, 2024 Maintainer

ccnicholls99 Jun 6, 2024 Author

Piedone Jun 6, 2024 Maintainer

ccnicholls99 Jun 7, 2024 Author

Piedone Jun 7, 2024 Maintainer

ccnicholls99 Jun 7, 2024 Author

ccnicholls99 Jun 7, 2024 Author

ccnicholls99 Jun 8, 2024 Author

ccnicholls99 Jun 8, 2024 Author

ccnicholls99 Jun 9, 2024 Author

Piedone Jun 9, 2024 Maintainer

ccnicholls99 Jun 9, 2024 Author

Piedone Jun 10, 2024 Maintainer

ccnicholls99
Jun 5, 2024

Replies: 5 comments 19 replies

hishamco
Jun 5, 2024
Maintainer

ccnicholls99 Jun 5, 2024
Author

hishamco Jun 6, 2024
Maintainer

ccnicholls99 Jun 6, 2024
Author

ccnicholls99 Jun 6, 2024
Author

hishamco Jun 6, 2024
Maintainer

Piedone
Jun 5, 2024
Maintainer

ccnicholls99 Jun 6, 2024
Author

Piedone Jun 6, 2024
Maintainer

ccnicholls99 Jun 7, 2024
Author

Piedone Jun 7, 2024
Maintainer

ccnicholls99 Jun 7, 2024
Author

ccnicholls99
Jun 7, 2024
Author

ccnicholls99 Jun 8, 2024
Author

ccnicholls99
Jun 8, 2024
Author

ccnicholls99
Jun 9, 2024
Author

Piedone Jun 9, 2024
Maintainer

ccnicholls99 Jun 9, 2024
Author

Piedone Jun 10, 2024
Maintainer