Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.33 KB

Readme.md

File metadata and controls

49 lines (33 loc) · 2.33 KB
Raw

Lombiq Hosting - Tenants Management for Orchard Core

Lombiq.Hosting.Tenants.Management NuGet

About

With the help of this module, you can set restrictions on tenant creation and set tenant level shell settings in the tenant editor.

Documentation

This module contains these features:

  • Lombiq.Hosting.Tenants.Management.ForbiddenTenantNames
  • Lombiq.Hosting.Tenants.Management.HideRecipesFromSetup
  • Lombiq.Hosting.Tenants.Management.ShellSettingsEditor

Lombiq.Hosting.Tenants.Management.ForbiddenTenantNames

With this module, you can specify a list of host names that cannot be used to create a tenant. You can write the list of forbidden host names as a JSON array in the appsettings.json as follows:

"OrchardCore": {
  "Lombiq_Hosting_Tenants_Management": {
    "Forbidden_Tenants_Options": {
      "RequestUrlHosts": [
        "forbidden.hostname1.net",
        "forbidden.hostname2.net"
      ]
    }
  }  
}

Lombiq.Hosting.Tenants.Management.HideRecipesFromSetup

With this module, you can specify tags for recipes that won't be listed on the setup screen of tenants. Recipes with those tags will still be available from the Default tenant admin UI and they'll also be available to be used via the AutoSetup feature.

By default you can use "HiddenFromSetupScreen" tag on the recipe to hide it or you can specify the recipe tags you want to hide using the HideRecipesByTagsFromSetup() method in the web project's ConfigureServices().

public void ConfigureServices(IServiceCollection services) =>
    services.AddOrchardCms(builder => builder.HideRecipesByTagsFromSetup("hiddenTag1", "hiddenTag2"))

NOTE: This extension method not only sets the tags you want to hide but also registers the feature as a setup feature. If you just want to use the default HideFromSetupScreen tag then just call the extension method without any parameter.

Lombiq.Hosting.Tenants.Management.ShellSettingsEditor

Adds a shell settings editor to the tenant editor page where you can set values that are not already present in the current ShellSetting for the given tenant. Only those settings will be displayed that were added from this editor.