Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Gibe/Umbraco.Community.RuntimeValidators
A community package of Umbraco Runtime Validators to use in your own solutions
https://github.com/Gibe/Umbraco.Community.RuntimeValidators
umbraco umbraco-cms umbraco-package umbraco-v10 umbraco-v11 umbraco-v12 umbraco-v13
Last synced: 2 months ago
JSON representation
A community package of Umbraco Runtime Validators to use in your own solutions
- Host: GitHub
- URL: https://github.com/Gibe/Umbraco.Community.RuntimeValidators
- Owner: Gibe
- License: mit
- Created: 2024-01-25T13:22:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-06T17:32:48.000Z (10 months ago)
- Last Synced: 2024-07-30T20:58:01.835Z (5 months ago)
- Topics: umbraco, umbraco-cms, umbraco-package, umbraco-v10, umbraco-v11, umbraco-v12, umbraco-v13
- Language: C#
- Homepage: https://gibe.digital
- Size: 60.5 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Umbraco.Community.RuntimeValidators
A community project of [Umbraco runtime validators](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/runtime-modes) to add to your projects to ensure your site has the correct configuration.
## Validators
### Azure Load Balancing
* `AzureLoadBalancing.ExamineValidator` - This checks to see if [Examine is using the correct LuceneDirectoryFactory](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing/azure-web-apps#lucene-examine-configuration)
* `AzureLoadBalancing.HostSyncValidator` - This checks to see if the [MainDom is configured correctly](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing/azure-web-apps#host-synchronization)
* `AzureLoadBalancing.TempFilesValidator` - This checks to see if the [LocalTempStorageLocation is set to EnvironmentTemp](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing/azure-web-apps#umbraco-temp-files)
## How to use
Install the NuGet package `Umbraco.Community.RuntimeValidators` into your Umbraco project.
You can add the validators to the collection of RuntimeValidators found in the Umbraco Application builder. You can do this directly in your startup.cs file or in a composer as shown in the various ways below.
```csharp
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Community.RuntimeValidators.Validators.AzureLoadBalancing;
using Umbraco.Extensions;
namespace YourProject.Website
public class RuntimeValidatorsComposer : IComposer
{
public void Compose(IUmbracoBuilder builder)
{
builder.RuntimeModeValidators()
.Add()
.Add()
.Add();
}
}
```
Alternatively you can use the extension method `AddAzureLoadBalancingValidators()` to add all the validators in the Azure Load Balancing namespace.
```csharp
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Community.RuntimeValidators;
using Umbraco.Extensions;
namespace YourProject.Website;
public class RuntimeValidatorsComposer : IComposer
{
public void Compose(IUmbracoBuilder builder)
{
// check running on a Azure Web App
if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("WEBSITE_INSTANCE_ID")))
{
builder.RuntimeModeValidators()
.AddAzureLoadBalancingValidators();
}
}
}
```
Or if you want fine grain control you can add each validator individually.
```csharp
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Extensions;
namespace YourProject.Website;
public class RuntimeValidatorsComposer : IComposer
{
public void Compose(IUmbracoBuilder builder)
{
builder.RuntimeModeValidators()
.Add()
.Add();
}
}
```
## Don't Forget
You will need to set the Runtime Mode in your `appsettings.json` file to `Production` for the current validators to run alongside Umbraco's own.
For further information and documentation about [Umbraco runtime modes, please refer to their documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/runtime-modes)
```json
{
"Umbraco": {
"CMS": {
"Runtime": {
"Mode" : "Production"
}
}
}
}
```
## Requirements
This class library is built against Umbraco 10.1.0 where the concept of RuntimeValidators was introduced, so your Umbraco build will need to use a minimum version of 10.1.0 or newer.
### Attributions
Validation icons created by Dewi Sari - Flaticon