geta-optimizely-sitemaps

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #machine-learning #deep-learning #macos #nodejs #windows #awesome #vue #awesome-list #mcp

geta-optimizely-sitemaps

(★ 13)

Search engine sitemaps.xml for Optimizely CMS 12 and Commerce 14

geta-optimizely-sitemaps Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Geta Optimizely Sitemaps

[![Platform](https://img.shields.io/badge/Platform-.NET%2010-blue.svg?style=flat)](https://docs.microsoft.com/en-us/dotnet/)
[![Platform](https://img.shields.io/badge/Optimizely-%2013-orange.svg?style=flat)](http://world.episerver.com/cms/)

Search engine sitemaps.xml for Optimizely CMS 13 and Commerce 15

## Description

This tool allows you to generate xml sitemaps for search engines to better index your Optimizely sites.

## Features

- sitemap generation as a scheduled job
- filtering pages by virtual directories
- ability to include pages that are in a different branch than the one of the start page
- ability to generate sitemaps for mobile pages
- it also supports multi-site and multi-language environments
- ability to augment URL generation

See the [editor guide](docs/editor-guide.md) for more information.

## Installation

The command below will install Sitemaps into your Optimizely project.

```
dotnet add package Geta.Optimizely.Sitemaps
```

The command below will install Sitemaps Commerce support into your Optimizely Commerce project.

```
dotnet add package Geta.Optimizely.Sitemaps.Commerce
```

## Configuration

For the Sitemaps to work, you have to call AddSitemaps extension method in Startup.ConfigureServices method. This method provides a configuration of default values. Below is a code with all possible configuration options:

```csharp
services.AddSitemaps(x =>
{
  x.EnableRealtimeSitemap = false;
  x.EnableRealtimeCaching = true;
  x.RealtimeCacheExpirationInMinutes = 60;
});
```

You can configure access to the sitemaps configuration tab by adding a custom policy (the default is WebAdmins):

```csharp
services.AddSitemaps(x =>
{
  x.EnableRealtimeSitemap = false;
  x.EnableRealtimeCaching = true;
  x.RealtimeCacheExpirationInMinutes = 60;
}, p => p.RequireRole(Roles.Administrators));
```

And for the Commerce support add a call to:
```csharp
services.AddSitemapsCommerce();
```

In order to augment Urls for a given set of content one must prepare to build a service that identifies content to be augmented
and yields augmented Uris from IUriAugmenterService.GetAugmentUris(IContent content, CurrentLanguageContent languageContentInfo, Uri fullUri) method.

1. [Create a service that implements IUriAugmenterService yielding multiple Uris per single input content/language/Uri.](src/Geta.Optimizely.Sitemaps.Web/Services/SitemapUriParameterAugmenterService.cs).
2. Ensure the services is set, overring the default service, within the optionsAction of AddSitemaps. For example:

```csharp
services.AddSitemaps(options =>
{
    options.SetAugmenterService<SitemapUriParameterAugmenterService>();
});
```

It is also possible to configure the application in `appsettings.json` file. A configuration from the `appsettings.json` will override configuration configured in Startup. Below is an `appsettings.json` configuration example.

```json
"Geta": {
    "Sitemaps": {
        "EnableRealtimeSitemap":  true,
        "RealtimeCacheExpirationInMinutes": 30
    }
}
```

Also, you have to add Razor pages routing support.

```csharp
app.MapRazorPages();
```

## Usage

### Adding Sitemap Properties to all content pages

Credits to [jarihaa](https://github.com/jarihaa) for [contributing](https://github.com/Geta/SEO.Sitemaps/pull/87) this.

```
[UIHint("SeoSitemap")]
[BackingType(typeof(PropertySEOSitemaps))]
public virtual string SEOSitemaps { get; set; }
```

#### Set default value

```
public override void SetDefaultValues(ContentType contentType)
{
    base.SetDefaultValues(contentType);
    var sitemap = new PropertySEOSitemaps
    {
        Enabled = false
    };
    sitemap.Serialize();
    this.SEOSitemaps = sitemap.ToString();
}
```

### Ignore page types

Implement the `IExcludeFromSitemap` interface to ignore page types in the sitemap.

```
public class OrderConfirmationPage : PageData, IExcludeFromSitemap
```

### Exclude content

If you need more control to exclude content from the sitemap you can make your own implementation of IContentFilter. Make sure to inherit from ContentFilter and call the `ShouldExcludeContent` method of the base class.

```
public class SiteContentFilter : ContentFilter
    {
        public override bool ShouldExcludeContent(IContent content)
        {
            if (base.ShouldExcludeContent(content))
            {
                return true;
            }

// Custom logic here

return false;
        }
    }
```

Register in your DI container. Be sure to register you custom ContentFilter _after_ calling ```services.AddSitemaps()```, otherwise the default ContentFilter will be used.

```csharp
services.AddTransient<IContentFilter, SiteContentFilter>();
```

## Limitations

- Each sitemap will contain max 50k entries (according to [sitemaps.org protocol](http://www.sitemaps.org/protocol.html#index)) so if the site in which you are using this plugin contains more active pages then you should split them over multiple sitemaps (by specifying a different root page or include/avoid paths for each).

## 🏁 Getting Started

### 📦 Prerequisites

Ensure your system is properly configured to meet all prerequisites for Geta Foundation Core listed [here](https://github.com/Geta/geta-foundation-core#%EF%B8%8F-prerequisites)

### 🐑 Cloning the repository

```bash
    git clone https://github.com/Geta/geta-optimizely-sitemaps.git
    cd geta-optimizely-sitemaps
    git submodule update --init
```

### 🚀 Running with Aspire (Recommended)
```bash
    # Windows
    cd sub/geta-foundation-core/src/Foundation.AppHost
    dotnet run

# Linux / MacOS
    sudo env "PATH=$PATH" bash
    chmod +x sub/geta-foundation-core/src/Foundation/docker/build-script/*.sh
    cd sub/geta-foundation-core/src/Foundation.AppHost
    dotnet run
```

### 🖥️ Running as Standalone
```bash
   # Windows
   cd sub/geta-foundation-core
   ./setup.cmd
   cd ../../src/Geta.Optimizely.Sitemaps.Web
   dotnet run

# Linux / MacOS
   sudo env "PATH=$PATH" bash
   cd sub/geta-foundation-core
   chmod +x *.sh
   ./setup.sh
   cd ../../src/Geta.Optimizely.Sitemaps.Web
   dotnet run
```

If you run into any issues, check the FAQ section [here](https://github.com/Geta/geta-foundation-core?tab=readme-ov-file#faq)

---

CMS username: admin@example.com

Password: Episerver123!

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## Package maintainer

https://github.com/marisks

## Changelog

[Changelog](CHANGELOG.md)

geta-optimizely-sitemaps

geta-optimizely-sitemaps Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

geta-optimizely-sitemaps

geta-optimizely-sitemaps Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README