Contribute to Docs Contribute to Docs

Getting Started

The fastest way to get started is to use one of the Project Templates available. If you want to read more about this, please go to Project Templates.

Installing From NuGet

All libraries and components are available on NuGet. You can read more about the available packages here.

Installing From GitHub

If you want the latest source code and maybe be a part of the community and contribute to Piranha you should head over to GitHub. You can read more about this in Contribute.

Project Setup

Configure the services

In ConfigureServices you should register the component services you want use in your application. As an example, let's look at the service configuration for a project that uses SQLite and AspNetCore Identity.

public void ConfigureServices(IServiceCollection services)
{
    services.AddLocalization(options =>
        options.ResourcesPath = "Resources"
    );
    services.AddMvc()
        .AddPiranhaManagerOptions()
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

    services.AddPiranha();
    services.AddPiranhaApplication();
    services.AddPiranhaFileStorage();
    services.AddPiranhaImageSharp();
    services.AddPiranhaManager();

    services.AddPiranhaEF(options =>
        options.UseSqlite("Filename=./piranha.razorweb.db"));
    services.AddPiranhaIdentityWithSeed<IdentitySQLiteDb>(options =>
        options.UseSqlite("Filename=./piranha.razorweb.db"));
}

Configure the application

Once the services has been configured you need to initialize Piranha. Let's again look at how it's done in the example project. Please note that generic AspNetCore setup has been omitted.

public void Configure(IApplicationBuilder app, IHostingEnvironment env, IApi api)
{
    ...
    // Initialize Piranha
    App.Init(api);

    // Build page types
    var pageTypeBuilder = new Piranha.AttributeBuilder.PageTypeBuilder(api)
        .AddType(typeof(Models.StandardPage))
        .AddType(typeof(Models.TeaserPage));
    pageTypeBuilder.Build()
        .DeleteOrphans();

    // Register middleware
    app.UseStaticFiles();
    app.UseAuthentication();
    app.UsePiranha();
    app.UsePiranhaManager();

    app.UseMvc(routes =>
    {
        ...
    });
    ...
}