Orchardcore Shells

Orchard Core Shells Configuration - Prompt Templates

Configure Shell Providers for Multi-Tenant Environments

You are an Orchard Core expert. Generate configuration and code for Azure Blob shell storage, database shell storage, migration from file-based providers, and environment-specific shell settings.

Guidelines

• By default, Orchard Core stores tenants.json and per-tenant appsettings.json in the App_Data folder.
• For stateless multi-instance deployments, use Azure Blob or Database shell configuration providers.
• Shell providers enable multiple hosts to share and mutate tenant configuration in a central store.
• Azure Blob provider stores files in a blob container hierarchy similar to App_Data.
• Database provider stores all tenant configuration as a single JSON document in a supported database.
• Both providers support MigrateFromFiles to automatically migrate existing App_Data configuration.
• Shell providers are configured in the startup project, not in individual tenant settings.
• Use environment-based conditional registration to disable providers in development.
• All recipe JSON must be wrapped in { "steps": [...] }.
• All C# classes must use the sealed modifier.

Azure Blob Shell Configuration

NuGet Package

Add the OrchardCore.Shells.Azure package to the web project:

<PackageReference Include="OrchardCore.Shells.Azure" Version="3.*" />

Configuration in appsettings.json

{
  "OrchardCore": {
    "OrchardCore_Shells_Azure": {
      "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net",
      "ContainerName": "orchardcore-shells",
      "BasePath": "",
      "MigrateFromFiles": true
    }
  }
}

Enable in Startup

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddOrchardCms()
    .AddAzureShellsConfiguration();

var app = builder.Build();
app.UseStaticFiles();
app.UseOrchardCore();
app.Run();

Azure Blob Container Hierarchy

The blob container mirrors the App_Data structure:

orchardcore-shells/
├── tenants.json
├── appsettings.json              (optional root config)
├── appsettings.Production.json   (optional environment config)
└── Sites/
    ├── Default/
    │   └── appsettings.json
    ├── TenantA/
    │   └── appsettings.json
    └── TenantB/
        └── appsettings.json

Note: The blob container must be created before the application starts. Individual tenant directories do not support environment-specific appsettings.{Environment}.json files, but the root level does.

Database Shell Configuration

Configuration in appsettings.json

{
  "OrchardCore": {
    "OrchardCore_Shells_Database": {
      "DatabaseProvider": "SqlConnection",
      "ConnectionString": "Server=db-server;Database=OrchardShells;Trusted_Connection=True;",
      "TablePrefix": "",
      "MigrateFromFiles": true
    }
  }
}

Note: The Database Shells provider does not support root-level appsettings.json or appsettings.{Environment}.json files.

Enable in Startup

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddOrchardCms()
    .AddDatabaseShellsConfiguration();

var app = builder.Build();
app.UseStaticFiles();
app.UseOrchardCore();
app.Run();

Migration from File-Based Configuration

Both providers support the MigrateFromFiles option to assist migrating from an existing App_Data configuration:

1. Set MigrateFromFiles to true in the provider configuration.
2. On startup, the provider checks if configuration exists for each tenant in the target store.
3. If no configuration exists, it reads from App_Data and writes to the target store.
4. Once migrated, the App_Data files can be removed (but keep as backup).

{
  "OrchardCore": {
    "OrchardCore_Shells_Database": {
      "DatabaseProvider": "Postgres",
      "ConnectionString": "Host=db-server;Database=orchardshells;Username=orcharduser;Password=P@ss;",
      "MigrateFromFiles": true
    }
  }
}

Environment-Specific Provider Registration

Disable the shell provider in development to use local App_Data files, and enable it in production:

var builder = WebApplication.CreateBuilder(args);

var orchardBuilder = builder.Services.AddOrchardCms();

if (!builder.Environment.IsDevelopment())
{
    orchardBuilder.AddDatabaseShellsConfiguration();
}

var app = builder.Build();
app.UseStaticFiles();
app.UseOrchardCore();
app.Run();

Environment-Specific with Azure Blob

var builder = WebApplication.CreateBuilder(args);

var orchardBuilder = builder.Services.AddOrchardCms();

if (builder.Environment.IsProduction())
{
    orchardBuilder.AddAzureShellsConfiguration();
}

var app = builder.Build();
app.UseStaticFiles();
app.UseOrchardCore();
app.Run();

Using Environment Variables for Configuration

Store shell provider settings in environment variables to avoid committing secrets:

Azure Blob via Environment Variables

OrchardCore__OrchardCore_Shells_Azure__ConnectionString=DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net
OrchardCore__OrchardCore_Shells_Azure__ContainerName=orchardcore-shells
OrchardCore__OrchardCore_Shells_Azure__MigrateFromFiles=true

Database via Environment Variables

OrchardCore__OrchardCore_Shells_Database__DatabaseProvider=SqlConnection
OrchardCore__OrchardCore_Shells_Database__ConnectionString=Server=db-server;Database=OrchardShells;Trusted_Connection=True;
OrchardCore__OrchardCore_Shells_Database__MigrateFromFiles=true

Multi-Instance Deployment Pattern

For load-balanced or horizontally scaled deployments where multiple app instances need to share tenant configuration:

{
  "OrchardCore": {
    "OrchardCore_Shells_Database": {
      "DatabaseProvider": "SqlConnection",
      "ConnectionString": "Server=central-db;Database=OrchardShells;User Id=shelluser;Password=ShellP@ss;",
      "TablePrefix": "Shell",
      "MigrateFromFiles": false
    }
  }
}

This ensures all instances read and write tenant configuration from the same central database, enabling:

• Tenant creation on any instance propagates to all instances.
• Tenant settings changes are immediately available cluster-wide.
• No reliance on local file system for configuration state.

Choosing Between Azure Blob and Database