When configuring Sitecore in a distributed environment, you typically have more than 1 server in the production environment configured as a different roles (CM, CD, Processing, Reporting Service, etc).
More often than not I’ve noticed that issues are raised due to misconfiguration rather than implementation itself. You then go to Sitecore documentation site and check the configuration for each of the server that you’ve setup to see if there’s anything that you miss.
- Configuring a content delivery server
- Configuring a content management server
- Configuring a processing server
- Configuring a reporting service server
In the 8.0 documentation you would need to read a long list of tables containing information which config files that you need to enable/disable.
Since the 8.1 release, these steps are simplified with Sitecore providing us an excel spreadsheet file as a guide to enable/disable the config files depending on the role(s) that you want to setup. These steps are manual though and highly likely that we will miss one or two config files and could cause some issues down the line.
With the number of projects that you need to review, this task will start eating up your time and should really be automated. Some might have already done so and create a little tool tucked away somewhere.
I’ve decided to create my own version of the tool called Sitecore Server Role Checker, can’t be more obvious than that 🙂
How does it work?
This tool would basically uses a converted csv format from the Sitecore official spreadsheet guide and read the configuration based on your selected roles. It currently supports the following Sitecore version
- 8.1 update 3
- 8.2 initial release
- 8.2 update 1
- 8.2 update 2
Only those version is supported as those are only the spreadsheet available for now.
How do I use it?
Follow this simple steps
- Choose your Sitecore version
- Choose your search engine provider
- Browse to your website folder
- Tick your intended role(s) for this particular Sitecore instance
- Click the Analyze button
It would then go through each of your configuration files and report if there’s any config files that should be enabled/disabled.
Through the tool you can also quickly disable/enable those config files.
What it doesn’t do
- Check if your config files is updated accordingly, e.q:
- Changing robot detection handler in CM
- Configuring remote reporting service url
- Check the configuration files for WFFM, EXM.. yet
- Make you coffee
Where can I get it?
The code is available in Github
Note that this tool is not deeply tested, if you have any issues or suggestions with the tool then raise a ticket in Github or do a PR
update: 22 February 2017
The tool is now available at Sitecore Marketplace