CodEaisy.TinySaas 1.0.0-rc3

TinySaas

TinySaas is a C# library for building multitenant applications with .NET Core 3.0+

Supported Use Cases

• Per-Tenant Services
• Shared Tenant Services
• Schema per Tenant (Data Isolation)
• Database per Tenant (Data Isolation)
• Shared Database (Data Isolation)

Quickstart

• Add dependency to CodEaisy.TinySaas from Nuget

dotnet add package CodEaisy.TinySaas --version 1.0.0-rc3

• In Startup.cs, add the following inside the ConfigureServices method.

    public void ConfigureServices(IServiceCollection services)
    {
        // register all global singleton services here, and also dependencies for your TenantStore and ResolutionStrategy if any
  
        // ...
  
        // OPTION 1
        services.AddMultiTenancy<Tenant, TenantStore<Tenant>, ResolutionStrategy>();
  
        // OPTION 2
        // uses default `CodEaisy.TinySaas.Model.TinyTenant` as tenant model
        services.AddMultiTenancy<TenantStore<TinyTenant>, TenantResolutionStrategy>();
  
        // ...
  
        // services.AddControllers();
    }
  

  NB: Option 1 - Tenant must implement CodEaisy.TinySaas.Interface.ITenant TenantStore and TenantResolutionStrategy must implement CodEaisy.TinySaas.Interface.ITenantStore and CodEaisy.TinySaas.Interface.ITenantResolutionStrategy respectively.

  Then, add the following in the Configure method

  public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  {
      if (env.IsDevelopment())
      {
          app.UseDeveloperExceptionPage();
      }
  
      // enable multitenant support, with missing tenant handler and tenant container
  
      // OPTION 1
      // missing tenant handler has a dependency that can be provided immediately
      app.UseMultitenancy<Tenant, MissingTenantHandler, MissingTenantOptions>(missingTenantOptions);
  
      // OPTION 2
      // missing tenant handler does not have a dependency or dependency is already registered in services
      app.UseMultitenancy<Tenant, MissingTenantHandler>();
  
      // OPTION 3
      // Use `SimpleTenant` as tenant model, and missing tenant handler does not have a dependency or dependency is already registered in services
      app.UseMultitenancy<TMissingTenantHandler>()
  
      // ...
  }
  

• In Program.cs, add the following in the CreateHostBuilder method.

  public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            })
            // OPTION 1: add multitenant support via TenantStartup class
            .ConfigureMultiTenancy<TenantStartup, Tenant>();
            // OPTION 2: add multitenant support via static method
            .ConfigureMultiTenancy<Tenant>(ClassName.StaticMethodName);
  

  NB: TenantStartup must implement IMultiTenantStartup ClassName.StaticMethodName must be of type System.Action<TTenant, Autofac.ContainerBuilder> where TTenant implements ITenant

Requirements

ASP.NET Core 3.0+

Changelog

Learn about the latest improvements.

Credits

Gunnar Peipman and Michael McKenna for their awesome works on Saas in ASP.NET Core.

Want to help ?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues in the hotlist: community-help.