Orchard Core 配置项说明

Orchard Core使用IShellConfiguration扩展了ASP.NET Core IConfiguration，以允许在应用程序范围的配置之上进行特定于租户的配置。虽然本文档使用OrchardCore.Cms.Web.csproj示例中Web应用程序的配置，但如果您在自己的Web应用程序中使用NuGet包中的Orchard，那么在项目中也可以使用Orchard。

配置资源

Orchard Core支持配置源层次结构。

1、ASP.NET Core项目的启动项，例如OrchardCore.Cms.Web.csproj、appsettings.json或根据环境appsettings.Development.json。
2、全局租户配置App_data/appsettings.json，或根据环境App_data/appsettings.Development.json。
3、位于App_Data/Sites/{Tenant_Name}/appsettings.json文件夹中每个租户文件夹下的各个租户配置文件。注意：这些是可变文件，不支持环境版本。
4、环境变量，或通过Azure将AppSettings作为环境变量。
配置源按上述顺序加载，层次结构中较低的设置将覆盖较高配置的值，例如：全局租户值将始终被环境变量覆盖。

下面appsettings.json示例中的IShellConfiguration模式仅适用于专门支持此类配置的模块。您可以查看给定模块的代码或文档，看看情况是否如此。
OrchardCore.Cms.Web.csproj启动项目中的IShellConfiguration。
Orchard Core将所有配置数据存储在appsettings.json文件中的OrchardCore部分下：

{
"OrchardCore": {
... module configurations ...
}
}

每个Orchard Core模块在OrchardCore部分下都有自己的配置部分：

{
"OrchardCore": {
"OrchardCore.Media": {
... individual module configuration ...
}
}
}

有关更多示例，请参见appsettings.json文件。

租户的预配置说明

要在创建租户之前预先配置租户的设置值，可以指定一个以租户命名的部分，其State值为Uninitialized

{
"OrchardCore": {
"MyTenant": {
"State": "Uninitialized",
"RequestUrlPrefix": "mytenant",
"ConnectionString": "...",
"DatabaseProvider": "SqlConnection"
}
}
}

然后，预配置的租户将出现在管理员的租户列表中，这些值将在设置租户时使用。

租户建立后配置说明

要在创建租户后配置租户的值，您可以指定一个以租户命名的部分，而不必提供状态值。

{
"OrchardCore": {
"Default": {
"OrchardCore_Media": {
... specific tenant configuration ...
}
}
}
}

全局租户数据访问配置

如果您希望所有租户都访问同一数据库，该怎么办？对应的配置可以保存在一个地方，而不是逐个为所有租户设置相同的连接字符串，如下所示：

{
"OrchardCore": {
"ConnectionString": "...",
"DatabaseProvider": "SqlConnection",
"Default" : {
"State": "Uninitialized",
"TablePrefix": "Default"
}
}
}

请注意，尽管您可以对租户使用相同的配置键(如前所述)，但这是在OrchardCore部分的根目录中。
为所有租户使用的数据库添加连接字符串。
DatabaseProvider应与使用的数据库引擎相对应，示例为SQL Server。
需要将TablePrefix配置为默认租户使用的前缀，以便可以为每个租户分隔表(否则，只有默认租户的表会缺少前缀)。然后，应为其他租户设置不同的前缀。
这样，通过在给定环境中配置相应数据库的设置，应用程序可以在不同环境之间轻松移动(如临时环境和生产环境)。租户的外壳设置不会包含此信息，所有租户将使用相同的全局配置。
相关主题是Shell配置提供程序。有关如何将所有外壳配置保留在数据库中的信息，请特别参阅关于数据库外壳配置提供程序的部分。

IOptions配置

您还可以从Web项目的Startup类中的代码配置IOptions。
许多Orchard Core功能都是通过管理UI配置的，站点设置存储在数据库中，和/或通过IOptions公开配置。如果您希望覆盖站点设置或默认设置，可以使用您自己的配置代码执行此操作。
例如，电子邮件模块允许通过SmtpSettings类进行SMTP配置，默认情况下，SmtpSettings类由给定租户的站点设置(在管理员上设置)填充。但是，您可以像这样覆盖Startup类中的站点设置(请注意，我们使用PostConfigure来覆盖站点设置值，但是如果模块不使用站点设置，您可以只使用Configure)：

services
.AddOrchardCms()
.ConfigureServices(tenantServices =>
tenantServices.PostConfigure<SmtpSettings>(settings =>
{
settings.Port = 255;
}));

// Or if you want to make use of IShellConfiguration as seen above:
services
.AddOrchardCms()
.ConfigureServices((tenantServices, serviceProvider) =>
{
// Instead of IShellConfiguration you could fetch the configuration
// values from an injected IConfiguration instance here too. While that
// would also allow you to access standard ASP.NET Core configuration
// keys it won't have support for all the hierarchical sources
// detailed above.
var shellConfiguration = serviceProvider.GetRequiredService<IShellConfiguration>();
var password = shellConfiguration.GetValue<string>("SmtpSettings:Password");

tenantServices.PostConfigure<SmtpSettings>(settings =>
{
settings.Password = password;
});
});

这将使SMTP端口使用此配置，而不考虑站点设置中定义的任何其他值。第二个示例的配置值可以来自例如appsettings.json文件，如下所示：

{
"OrchardCore": {
"SmtpSettings": {
"Password": "password"
}
}
}

在管理页面不会有此覆盖发生的提示，并且那里显示的值仍将是站点设置中配置的值，所以如果您选择这样做，您需要让您的用户知道。

ORCHARD_APP_DATA 环境变量

可以通过设置ORCHARD_APP_DATA环境变量来配置App_Data文件夹的位置。路径可以是相对于应用程序路径(./App_data)、绝对路径(/path/from/root)或完全限定路径(D：\path\to\App_data)。如果该文件夹不存在，应用程序将尝试创建它。

IShellConfiguration 配置在全局租户配置在App_data/appsettings.json中

这些设置也可以位于App_Data/appsettings.json文件夹(默认情况下不创建)中，其中指定的任何设置都将覆盖启动项目中的设置。

IShellConfiguration配置在单独的租户文件夹中

这些设置是可变的，并且在为租户设置期间写入。因此，不支持读取环境名称。此外，这些appsettings.json文件不需要OrchardCore节。

{
  "OrchardCore_Media": {
    ... specific tenant configuration ...
  }
}

IShellConfiguration通过环境变量配置

OrchardCore__OrchardCore_Media__MaxFileSize

OrchardCore__Default__OrchardCore_Media__MaxFileSize

OrchardCore__MyTenant__OrchardCore_Media__MaxFileSize

为了支持Linux，下划线_用作分隔符，例如OrchardCore_Media。 OrchardCore.Media也支持向后兼容，建议用户使用_的方式。

层级顺序

默认情况下，Orchard核心站点将在启动项目的Program.cs中使用CreateDefaultBuilder，它将按以下顺序加载IConfiguration。

1、启动项目appsettings.json。
2、启动项目appsettings.{Environment}.json。
3、用户机密(如果环境为开发)。
4、环境变量。
5、命令行参数。
6、然后，IShellConfiguration将为特定租户添加这些1.app_data/appsettings.json 2.app_data/site/{Tenant_Name}/appsettings.json。

注意：后面加载的如果具有相同Key的配置优先于较早加载的配置，以后面的为准。