Publikasikan ke IIS, atur Variabel Lingkungan

Membaca dua pertanyaan / jawaban ini saya dapat menjalankan aplikasi Asp.net 5 di server IIS 8.5.

Asp.net vNext beta awal diterbitkan ke IIS di windows server

Bagaimana cara mengkonfigurasi aplikasi MVC6 agar berfungsi pada IIS?

Masalahnya adalah bahwa aplikasi web masih menggunakan env.EnvironmentNamedengan nilai Developmentbahkan ketika dijalankan di IIS.

Juga, saya ingin menjalankan dua versi Web yang sama (Pementasan, Produksi) pada server yang sama, jadi saya perlu metode untuk mengatur variabel untuk setiap Web secara terpisah.

Bagaimana cara melakukannya?

Jawaban ini awalnya ditulis untuk ASP.NET Core RC1. Dalam RC2 ASP.NET Core pindah dari handler httpPlafrom generik ke aspnetCore yang spesifik. Perhatikan bahwa langkah 3 tergantung pada versi ASP.NET Core apa yang Anda gunakan.

Ternyata variabel lingkungan untuk proyek-proyek ASP.NET Core dapat diatur tanpa harus menetapkan variabel lingkungan untuk pengguna atau harus membuat beberapa entri perintah.

1. Buka aplikasi Anda di IIS dan pilih Configuration Editor.
2. Pilih Configuration Editor
3. Pilih system.webServer/aspNetCore(RC2 dan RTM) atau system.webServer/httpPlatform(RC1) dalam kotak Sectionkombo
4. Pilih Applicationhost.config ...dalam kotak Fromkombo.
5. Klik kanan pada enviromentVariableselemen, pilih 'environmentVariables' element, lalu Edit Items.
6. Tetapkan variabel lingkungan Anda.
7. Tutup jendela dan klik Terapkan.
8. Selesai

Dengan cara ini Anda tidak perlu membuat pengguna khusus untuk kumpulan Anda atau membuat entri perintah tambahan project.json. Juga, menambahkan perintah khusus untuk setiap kerusakan lingkungan "build sekali, sebarkan berkali-kali" karena Anda harus memanggil dnu publishsecara terpisah untuk setiap lingkungan, alih-alih menerbitkan sekali dan menggunakan artefak yang dihasilkan berkali-kali.

Diperbarui untuk RC2 dan RTM, terima kasih kepada Mark G dan tredder.

Perbarui web.config dengan bagian <environmentVariables> di bawah <aspNetCore>

<configuration>
  <system.webServer>
    <aspNetCore .....>
      <environmentVariables>
        <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Development" />
      </environmentVariables>
    </aspNetCore>
  </system.webServer>
</configuration>

Atau untuk menghindari kehilangan pengaturan ini saat menimpa web.config, buat perubahan serupa ke applicationHost.config dengan menetapkan lokasi situs seperti yang disarankan @NickAb.

<location path="staging.site.com">
    <system.webServer>
        <aspNetCore>
            <environmentVariables>
                <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Staging" />
            </environmentVariables>
        </aspNetCore>
    </system.webServer>
</location>
<location path="production.site.com">
    <system.webServer>
        <aspNetCore>
            <environmentVariables>
                <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Production" />
            </environmentVariables>
        </aspNetCore>
    </system.webServer>
</location>

Sunting: pada rilis RC2 dan RTM, saran ini kedaluwarsa. Cara terbaik yang saya temukan untuk menyelesaikan ini dalam rilis adalah dengan mengedit bagian web.config berikut di IIS untuk setiap lingkungan:

system.webServer/aspNetCore:

Edit entri environmentVariable dan tambahkan pengaturan variabel lingkungan:

ASPNETCORE_ENVIRONMENT : < Your environment name >

Sebagai alternatif dari pendekatan drpdrp, Anda dapat melakukan hal berikut:

• Di project.json Anda, tambahkan perintah yang meneruskan variabel ASPNET_ENV langsung ke Kestrel:

  "commands": {
      "Development": "Microsoft.AspNet.Server.Kestrel --ASPNET_ENV Development",
      "Staging": "Microsoft.AspNet.Server.Kestrel --ASPNET_ENV Staging",
      "Production": "Microsoft.AspNet.Server.Kestrel --ASPNET_ENV Production"
  }
  

• Saat menerbitkan, gunakan --iis-commandopsi untuk menentukan lingkungan:

  dnu publish --configuration Debug --iis-command Staging --out "outputdir" --runtime dnx-clr-win-x86-1.0.0-rc1-update1
  

Saya menemukan pendekatan ini kurang mengganggu daripada menciptakan pengguna IIS tambahan.

Saya memiliki aplikasi web saya (PRODUCTION, STAGING, TEST) di-host di server web IIS. Jadi tidak mungkin untuk bergantung pada variabel lingkungan sistem operatif ASPNETCORE_ENVIRONMENT, karena mengaturnya ke nilai tertentu (misalnya STAGING) berpengaruh pada aplikasi lain.

Sebagai solusi, saya mendefinisikan file khusus (envsettings.json) dalam solusi visualstudio saya:

dengan konten berikut:

{
  // Possible string values reported below. When empty it use ENV variable value or Visual Studio setting.
  // - Production
  // - Staging
  // - Test
  // - Development
  "ASPNETCORE_ENVIRONMENT": ""
}

Kemudian, berdasarkan pada jenis aplikasi saya (Produksi, Pementasan atau Uji) saya mengatur file ini sesuai: seandainya saya menggunakan aplikasi TEST, saya akan memiliki:

"ASPNETCORE_ENVIRONMENT": "Test"

Setelah itu, dalam file Program.cs hanya mengambil nilai ini dan kemudian mengatur lingkungan webHostBuilder:

    public class Program
    {
        public static void Main(string[] args)
        {
            var currentDirectoryPath = Directory.GetCurrentDirectory();
            var envSettingsPath = Path.Combine(currentDirectoryPath, "envsettings.json");
            var envSettings = JObject.Parse(File.ReadAllText(envSettingsPath));
            var enviromentValue = envSettings["ASPNETCORE_ENVIRONMENT"].ToString();

            var webHostBuilder = new WebHostBuilder()
                .UseKestrel()
                .CaptureStartupErrors(true)
                .UseSetting("detailedErrors", "true")
                .UseContentRoot(currentDirectoryPath)
                .UseIISIntegration()
                .UseStartup<Startup>();

            // If none is set it use Operative System hosting enviroment
            if (!string.IsNullOrWhiteSpace(enviromentValue)) 
            { 
                webHostBuilder.UseEnvironment(enviromentValue);
            }

            var host = webHostBuilder.Build();

            host.Run();
        }
    }

Ingatlah untuk menyertakan envsettings.json dalam publishOptions (project.json):

  "publishOptions":
  {
    "include":
    [
      "wwwroot",
      "Views",
      "Areas/**/Views",
      "envsettings.json",
      "appsettings.json",
      "appsettings*.json",
      "web.config"
    ]
  },

Solusi ini membuat saya bebas untuk memiliki aplikasi ASP.NET CORE yang di-host pada IIS yang sama, terlepas dari nilai variabel envoroment.

Setelah googling ekstensif saya menemukan solusi yang berfungsi, yang terdiri dari dua langkah.

Langkah pertama adalah mengatur variabel lingkungan sistem lebar ASPNET_ENV ke Produksi dan Restart Windows Server . Setelah ini, semua aplikasi web mendapatkan nilai 'Produksi' sebagai EnvironmentName.

Langkah kedua (untuk mengaktifkan nilai 'Pementasan' untuk pementasan web) agak lebih sulit untuk bisa berfungsi dengan benar, tetapi ini dia:

1. Buat pengguna windows baru, misalnya StagingPool di server.
2. Untuk pengguna ini, buat variabel pengguna baru ASPNETCORE_ENVIRONMENT dengan nilai 'Staging' (Anda dapat melakukannya dengan masuk sebagai pengguna ini atau melalui regedit)
3. Kembali sebagai admin di manajer IIS, cari Pool Aplikasi di mana web Staging sedang berjalan dan dalam Pengaturan Lanjut atur Identity ke pengguna StagingPool .
4. Juga atur Load User Profile menjadi true , sehingga variabel lingkungan dimuat. <- sangat penting!
5. Pastikan StagingPool memiliki hak akses ke folder web dan Stop dan Mulai Aplikasi Pool.

Sekarang web Staging harus memiliki EnvironmentName diatur ke 'Staging'.

Pembaruan: Di Windows 7+ ada perintah yang dapat mengatur variabel lingkungan dari CMD prompt juga untuk pengguna tertentu. Output ini membantu plus sampel:

>setx /?

Atau Anda bisa meneruskan yang diinginkan ASPNETCORE_ENVIRONMENTke dalam perintah dotnet publish sebagai argumen menggunakan:

/p:EnvironmentName=Staging

misalnya:

dotnet publish /p:Configuration=Release /p:EnvironmentName=Staging

Ini akan menghasilkan web.config dengan lingkungan yang benar yang ditentukan untuk proyek Anda:

<environmentVariables>
  <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Staging" />
</environmentVariables>

Selain opsi yang disebutkan di atas, ada beberapa Solusi lain yang bekerja dengan baik dengan penyebaran otomatis atau memerlukan lebih sedikit perubahan konfigurasi.

1. Memodifikasi file proyek (.CsProj) file

MSBuild mendukung EnvironmentNameProperti yang dapat membantu mengatur variabel lingkungan yang tepat sesuai Lingkungan yang ingin Anda Gunakan. Nama lingkungan akan ditambahkan di web.config selama fase Publikasikan.

Cukup buka file proyek (* .csProj) dan tambahkan XML berikut.

<!-- Custom Property Group added to add the Environment name during publish
  The EnvironmentName property is used during the publish for the Environment variable in web.config
  -->
  <PropertyGroup Condition=" '$(Configuration)' == '' Or '$(Configuration)' == 'Debug'">
    <EnvironmentName>Development</EnvironmentName>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)' != '' AND '$(Configuration)' != 'Debug' ">
    <EnvironmentName>Production</EnvironmentName>
  </PropertyGroup>

Kode di atas akan menambahkan nama lingkungan Developmentuntuk konfigurasi Debug atau jika tidak ada konfigurasi yang ditentukan. Untuk Konfigurasi lainnya, nama Lingkungan akan berada Productiondi file web.config yang dibuat. Lebih detail di sini

2. Menambahkan Properti EnvironmentName di profil terbitkan.

Kami dapat menambahkan <EnvironmentName>properti di profil terbitkan juga. Buka file profil publikasikan yang terletak di Properties/PublishProfiles/{profilename.pubxml}Ini akan mengatur nama Lingkungan di web.config ketika proyek diterbitkan. Lebih detail di sini

<PropertyGroup>
  <EnvironmentName>Development</EnvironmentName>
</PropertyGroup>

3. Opsi baris perintah menggunakan dotnet publish

Selain itu, kita bisa meneruskan properti EnvironmentNamesebagai opsi baris perintah ke dotnet publishperintah. Perintah berikut akan menyertakan variabel lingkungan seperti Developmentpada file web.config.

dotnet publish -c Debug -r win-x64 /p:EnvironmentName=Development

Untuk memperluas jawaban @ tredder, Anda dapat mengubah environmentVariables menggunakan appcmd

Pementasan

%windir%\system32\inetsrv\appcmd set config "staging.example.com" /section:system.webServer/aspNetCore /+environmentVariables.[name='ASPNETCORE_ENVIRONMENT',value='Staging'] /commit:APPHOST

Produksi

%windir%\system32\inetsrv\appcmd set config "example.com" /section:system.webServer/aspNetCore /+environmentVariables.[name='ASPNETCORE_ENVIRONMENT',value='Production'] /commit:APPHOST

Apa yang perlu Anda ketahui di satu tempat:

• Agar variabel lingkungan menimpa pengaturan konfigurasi, mereka harus diawali dengan ASPNETCORE_.
• Jika Anda ingin mencocokkan node anak di konfigurasi JSON Anda, gunakan :sebagai pemisah. Jika platform tidak mengizinkan titik dua dalam kunci variabel lingkungan, gunakan __saja.
• Anda ingin pengaturan Anda berakhir ApplicationHost.config. Menggunakan Editor Konfigurasi IIS akan menyebabkan input Anda ditulis ke aplikasi Web.config- dan akan ditimpa dengan penyebaran selanjutnya!

• Untuk memodifikasi ApplicationHost.config, Anda ingin menggunakan appcmd.exeuntuk memastikan modifikasi Anda konsisten. Contoh:%systemroot%\system32\inetsrv\appcmd.exe set config "Default Web Site/MyVirtualDir" -section:system.webServer/aspNetCore /+"environmentVariables.[name='ASPNETCORE_AWS:Region',value='eu-central-1']" /commit:site

• Karakter yang bukan URL-safe dapat diloloskan sebagai Unicode, seperti %u007buntuk braket keriting kiri.

• Untuk daftar pengaturan Anda saat ini (dikombinasikan dengan nilai-nilai dari Web.config): %systemroot%\system32\inetsrv\appcmd.exe list config "Default Web Site/MyVirtualDir" -section:system.webServer/aspNetCore
• Jika Anda menjalankan perintah untuk mengatur kunci konfigurasi beberapa kali untuk kunci yang sama, itu akan ditambahkan beberapa kali! Untuk menghapus nilai yang ada, gunakan sesuatu seperti %systemroot%\system32\inetsrv\appcmd.exe set config "Default Web Site/MyVirtualDir" -section:system.webServer/aspNetCore /-"environmentVariables.[name='ASPNETCORE_MyKey',value='value-to-be-removed']" /commit:site.

Mirip dengan jawaban lain, saya ingin memastikan pengaturan lingkungan ASP.NET Core 2.1 saya bertahan di seluruh penyebaran, tetapi juga hanya berlaku untuk situs tertentu.

Menurut dokumentasi Microsoft, dimungkinkan untuk mengatur variabel lingkungan di kumpulan aplikasi menggunakan perintah PowerShell berikut di IIS 10:

$appPoolName = "AppPool"
$envName = "Development"
cd "$env:SystemRoot\system32\inetsrv"
.\appcmd.exe set config -section:system.applicationHost/applicationPools /+"[name='$appPoolName'].environmentVariables.[name='ASPNETCORE_ENVIRONMENT',value='$envName']" /commit:apphost

Sayangnya saya masih harus menggunakan IIS 8.5 dan berpikir saya kurang beruntung. Namun, masih dimungkinkan untuk menjalankan skrip PowerShell sederhana untuk menetapkan nilai variabel lingkungan khusus situs untuk ASPNETCORE_ENVIRONMENT:

Import-Module -Name WebAdministration
$siteName = "Site"
$envName = "Development"
Set-WebConfigurationProperty -PSPath IIS:\ -Location $siteName -Filter /system.webServer/aspNetCore/environmentVariables -Name . -Value @{ Name = 'ASPNETCORE_ENVIRONMENT'; Value = $envName }

Solusi @tredder dengan mengedit applicationHost.config adalah yang berfungsi jika Anda memiliki beberapa aplikasi berbeda yang terletak di dalam direktori virtual di IIS.

Kasus saya adalah:

• Saya punya proyek API dan proyek APP , di bawah domain yang sama, ditempatkan di direktori virtual yang berbeda
• Root halaman XXX tampaknya tidak menyebarkan variabel ASPNETCORE_ENVIRONMENT ke anak-anaknya di direktori virtual dan ...
• ... Saya tidak dapat mengatur variabel di dalam direktori virtual seperti yang dijelaskan @NickAb (mendapat kesalahan Permintaan tidak didukung. (Pengecualian dari HRESULT: 0x80070032) selama menyimpan perubahan di Editor Konfigurasi):

• Masuk ke applicationHost.config dan secara manual membuat node seperti ini:

  <location path="XXX/app"> <system.webServer> <aspNetCore> <environmentVariables> <clear /> <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Staging" /> </environmentVariables> </aspNetCore> </system.webServer> </location> <location path="XXX/api"> <system.webServer> <aspNetCore> <environmentVariables> <clear /> <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Staging" /> </environmentVariables> </aspNetCore> </system.webServer> </location>

dan memulai kembali IIS melakukan pekerjaan.

Untuk mendapatkan rincian tentang kesalahan saya harus menambahkan ASPNETCORE_ENVIRONMENTvariabel lingkungan untuk Pool Aplikasi yang sesuai system.applicationHost/applicationPools .

Catatan: aplikasi web dalam kasus saya adalah ASP.NET Core 2aplikasi web yang dihosting pada IIS 10. Ini dapat dilakukan melalui Configuration Editordalam IIS Manager(lihat Mengedit Koleksi dengan Editor Konfigurasi untuk mengetahui di mana menemukan editor ini IIS Manager).

Saya telah membuat repositori untuk menerbitkan IIS dengan konfigurasi lingkungan di Web.config.

https://github.com/expressiveco/AspnetCoreWebConfigForEnvironment

• Mempersiapkan
  • Dapatkan bagian dari file .csproj dan .user.csproj ke file proyek Anda.
  • Dapatkan file MyAspNetEnvironment.props, web.development.config dan web.production.config.
• Konfigurasi
  • Ubah nilai properti ASPNETCORE_ENVIRONMENT di user.csproj secara relevan.

Saya telah memodifikasi jawaban yang diberikan @Christian Del Bianco . Saya mengubah proses untuk .net core 2 dan lebih tinggi sebagai file project.json sekarang mutlak.

1. Pertama, buat file appsettings.json di direktori root. dengan konten

     {
        // Possible string values reported below. When empty it use ENV 
           variable value or Visual Studio setting.
        // - Production
        // - Staging
        // - Test
       // - Development
      "ASPNETCORE_ENVIRONMENT": "Development"
    }
   

2. Kemudian buat dua pengaturan lain file appsettings.Development.json dan appsettings.Production.json dengan konfigurasi yang diperlukan.

3. Tambahkan kode yang diperlukan untuk mengatur lingkungan ke file Program.cs .

   public class Program
   {
   public static void Main(string[] args)
   {
       var logger = NLogBuilder.ConfigureNLog("nlog.config").GetCurrentClassLogger();
   
     ***var currentDirectoryPath = Directory.GetCurrentDirectory();
       var envSettingsPath = Path.Combine(currentDirectoryPath, "envsettings.json");
       var envSettings = JObject.Parse(File.ReadAllText(envSettingsPath));
       var enviromentValue = envSettings["ASPNETCORE_ENVIRONMENT"].ToString();***
   
       try
       {
           ***CreateWebHostBuilder(args, enviromentValue).Build().Run();***
       }
       catch (Exception ex)
       {
           //NLog: catch setup errors
           logger.Error(ex, "Stopped program because of setup related exception");
           throw;
       }
       finally
       {
           NLog.LogManager.Shutdown();
       }
   }
   
   public static IWebHostBuilder CreateWebHostBuilder(string[] args, string enviromentValue) =>
       WebHost.CreateDefaultBuilder(args)
           .UseStartup<Startup>()
           .ConfigureLogging(logging =>
           {
               logging.ClearProviders();
               logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);
           })
           .UseNLog()
           ***.UseEnvironment(enviromentValue);***
   

   }

4. Tambahkan envsettings.json untuk Anda .csproj file untuk copy ke direktori diterbitkan.

      <ItemGroup>
           <None Include="envsettings.json" CopyToPublishDirectory="Always" />
       </ItemGroup>
   

5. Sekarang cukup ubah ASPNETCORE_ENVIRONMENT seperti yang Anda inginkan dalam file envsettings.json dan diterbitkan.