ASP.NET Core Web Applications

Last updated

ASP.NET Core is the future of ASP.NET, and it contains many changes to how applications are built, and how they are run.

Publishing and Packing the Website

Once you have a project up and running (see the getting started guide), it needs to be published and packed:

# Publish the application to a folder
dotnet publish source/MyApp.Web --output published-app --configuration Release

# Package the folder into a ZIP
octo pack --id MyApp.Web --version 1.0.0 --basePath published-app

If you are using the built-in repository, you can create a zip file instead. The generated nupkg or zip file should then be then be pushed to a repository.

If you are using TeamCity, you can use the new TeamCity plugin for dotnet commands.

Why not OctoPack?
OctoPack is not compatible with ASP.NET Core applications. Please see the OctoPack documentation for more details.

Deployment

ASP.NET Core applications can either run as a command line program with Kestrel, or under IIS (which also uses Kestrel - check out the book for details).

See the ASP.NET Core IIS documentation for instructions on setting up IIS for ASP.NET Core.

When running under IIS, ensure the .NET CLR Version is set to No Managed Code.

Antiforgery Cookie

The .AspNetCore.Antiforgery cookie created by ASP.NET Core uses the application path to generate its hash. By default Octopus will deploy to a new path every time, which causes a new cookie to be set every deploy. This results in many unneeded cookies in the browser. See this blog post for more details. To change this behavior, set the Antiforgery token in your startup.cs like this:

public void ConfigureServices(IServiceCollection services)
{
    services.AddAntiforgery(opts => opts.CookieName = "AntiForgery.MyAppName");
}

Cookie Authentication in ASP.NET Core 2

Similar to antiforgery cookies, cookie authentication in ASP.NET Core 2 uses Microsoft's data protection API (DPAPI) which can use the application path to isolates applications from one another. This can cause older cookies to simply not work. To change this behavior, you need to set the application name in your startup.cs like this:

public void ConfigureServices(IServiceCollection services)
{
    services.AddDataProtection().SetApplicationName("my application");
}

Configuration

ASP.NET Core introduces a new JSON-based configuration file format. Octopus 3.3 introduced a new convention which can be used to update these JSON configuration files with Octopus variables:

Feature Configuration

JSON variable subsitute

For more information, see the section on the JSON Configuration Variables Feature.