Azure App Service Deploy

第一次直接從 VS 2022 布署到 Azure App Service 時，會遇到一些問題，這邊做一個紀錄。

結論

在 Azure App Service 的環境變數中新增 ASPNETCORE_ENVIRONMENT = Dev ，這樣就可以讓專案知道目前的環境是 Dev。
在 Azure App Service 的環境變數中新增 WEBSITE_LOAD_CERTIFICATES = * ，這樣就可以讓 Azure App Service 讀取到該憑證。
找到專案 AuthServer 內的 authserver.pfx 檔案
找到專案 AuthServer 內的 AuthServerModule.cs 的 GetSigningCertificate 方法裡面的 passPhrase 變數
在 Azure App Service 的證書選擇 攜帶您自己的憑證 並上傳 authserver.pfx 檔案，其中密碼為 passPhrase 變數的值

其他

修改對應設定，尤其 DbMigrator 的設定，確保執行 Seed Data 時， DB 是正確的值，不然可能要手動修正 DB 與 Redis 的資料。

Azure App Service 環境變數 (部署位置設定記得勾起來)
- ASPNETCORE_ENVIRONMENT (Production, Staging, Dev)
- Redis:Configuration
- ConnectionStrings:Default
appsetting..json
- App:SelfUrl
- App:CorsOrigins
- App:RedirectAllowedUrls
- AuthServer:Authority
- OpenIddict:Applications::RootUrl
- RemoteServices:Default:BaseUrl
- RemoteServices:AbpAccountPublic:BaseUrls

部署位置設定意思是在 Azure App Service 做 Swap 時，設定值會固定在原本的網站，反過來說就是如果沒有打勾，Swap 後設定值會跟著移動。

範例

authserver.pfx
passPhrase = "xxxxxxxxxxxx"

AuthServerModule.cs

private X509Certificate2 GetSigningCertificate(IWebHostEnvironment hostingEnv)
    {
        var fileName = "authserver.pfx";
        var passPhrase = "xxxxxxxxxxxx";
        var file = Path.Combine(hostingEnv.ContentRootPath, fileName);

        if (!File.Exists(file))
        {
            throw new FileNotFoundException($"Signing Certificate couldn't found: {file}");
        }

        return new X509Certificate2(file, passPhrase);
    }

錯誤訊息

500.30 - ANCM In-Process Start Failure

原因

在 Azure App Service 上，OpenIddict 需要使用憑證來簽署 JWT，但 Azure App Service 預設不會讀取專案內的憑證。

Log

原始程式碼會看不到錯誤 Log，可以修改 Program.cs 來看到詳細錯誤訊息。

public async static Task<int> Main(string[] args)
    {
    // 新增這段程式碼
        Log.Logger = new LoggerConfiguration()
#if DEBUG
        .MinimumLevel.Debug()
#else
        .MinimumLevel.Information()
#endif
        .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
        .MinimumLevel.Override("Microsoft.EntityFrameworkCore", 
            LogEventLevel.Information)
        .Enrich.FromLogContext()
        .WriteTo.Async(c => c.File("Logs/logs.txt", 
            rollingInterval: RollingInterval.Day))
        .WriteTo.Async(c => c.Console())
        .CreateLogger();

try
        {
            Log.Information("Starting AuthServer.");
// ...

利用以上程式碼防止主程序啟動失敗時，連帶 Log 也無法正常輸出。

404

預設網址長度 2048 字元，如果超過會出現 404 錯誤。

maxQueryString
maxQueryStringLength

web.config

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath="dotnet" arguments=".\MyProj.AuthServer.dll" stdoutLogEnabled="false" stdoutLogFile=".\Logs\stdout" hostingModel="inprocess" />
    </system.webServer>
  </location>
  <system.webServer>
    <httpProtocol>
      <customHeaders>
        <remove name="x-powered-by" />
      </customHeaders>
    </httpProtocol>
    <security>
      <requestFiltering>
        <requestLimits maxQueryString="4096" />
      </requestFiltering>
    </security>
  </system.webServer>
  <system.web>
    <httpRuntime maxQueryStringLength = "4096" />
  </system.web>
</configuration>

參照

Publish-an-abpio-project-to-an-azure-AppServices-Error-OpenIddict

Last modified: 04 November 2024