Skip to main content

Config-Per-Site in Multi-Tenant Environments

Recently, a task was given to me at work where we needed a multisite configuration. We all know that multi-environment is as easy as appsettings.<environment_name>.config. What about in multi-tenant environments? You can't have appsettings.site1.config and appsettings.site2.config in your site! Well, not without a little extra work...

Allow me to introduce AddKeyPerFile; this handy little function that you set up in your Program.cs will enumerate the files in a directory and add them to your Configuration. 

"Alright!" you must be thinking "Show me how this miracle function works..." Well, let's get to it! First, you'll want to identify the config sections that will be unique to each site and put them in their own folder. I do this by site name because it makes the most sense by our conventions, if something else works for your practice, these names aren't set in stone. 



Now, in order to suck those values into your config, there's one simple line to add to Program.cs:

 var configBuilder = new ConfigurationBuilder()

 .SetBasePath(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location))

 .AddJsonFile("appsettings.json", false, true)

 .AddJsonFile($"appsettings.Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", true, true)

 .AddJsonFile("appsettings.local.json", true, true)

 .AddJsonFile($"appsettings.{Environment.MachineName}.json", true, true)

 .AddKeyPerFile(Path.Combine(Directory.GetCurrentDirectory(), "SiteConfigs"), true, true)

 .AddEnvironmentVariables();


AddKeyPerFile expects at least a fully qualified path to the config folder, no short cutting this. The following two bools indicate if the file is optional, and to reload the file if it changes, respectively and these are optional.

So, now that we've got them in the Configuration, how do we get them out? Simple:

_configuration[$"{siteName}.json"];

This is where your file naming convention comes into play, you need to be able to look them up by name in Configuration, so make sure it's something you can work with. However, there's a snag with this... We get the entire contents of the file as a value, so we'll need to deserialize that into something a bit more usable:

var jsonSettings = JsonConvert.DeserializeObject<StyleSettings>(_configuration[$"{siteName}.json"] ?? string.Empty);

And there we go; we've got access to Configuration values on a per-site basis. 

Comments

Popular posts from this blog

Optimizely Gets More (Case-)Sensitive

As Windows developers, we don't always have to pay attention to capitalization when dealing with paths and URIs. With CMS12, Optimizely has started deploying to a Linux container for hosting sites. This means that deployed sites (and developers!) will have to pay attention to capitals in references. Inconsistent capitalization can cause 404 errors in unexpected places. Thankfully there's a few ways to handle that!  The worst part of this is that developers won't be able to find these issues until deployed to Azure, with Windows, being case in-sensitive and all. Once named, files and folders can be difficult to change in git. Below are some ways to help rename your files so that they'll play nicely in Linux. Rename via Git mv Command   One way to update capitalization is by the git mv command. In you git command shell:  git mv <source> <target> This command will rename a file or folder, however it still runs in the context of Windows. If you want to simply ch

The 1001st Piece in your 1000 Piece Puzzle: .NET Default Interface Functions

I was recently working with a client who wanted a reasonably large subsystem added to Optimizely that would add automated management to their content. While cutting the code for this, I found myself writing similar code across multiple classes. The reason why I had to write it that way was: 1) The client was currently on CMS11 and didn't have access to newer language features; 2) The hierarchy of the classes prevented me from inserting a common ancestor. Thankfully, .NET has expanded the functionality of interfaces, so we can take advantage of those within Optimizely. With .NET 5, Microsoft introduced default implementations on interfaces. Now interfaces can bring along a default implementation. Resulting in all classes that implement the interface can use the default implementation or override it with custom logic. Enough text! Let's code! Original Interface The following code is something that we'd create for an Optimizely experiment: using OptimizelySDK; using Optimizely