Table of Contents

Proxy and Validation Helpers

The ingress package includes helpers for computing public URLs, generating reverse-proxy snippets, and checking whether your local configuration matches your Discord application.

These helpers are split by concern:

  • DisCatSharp.Hosting.AspNetCore.Routing for computed public URLs
  • DisCatSharp.Hosting.AspNetCore.Deployment for proxy snippets
  • DisCatSharp.Hosting.AspNetCore.Validation for offline configuration checks

Compute the public URLs

Use DiscordIngressPublicUrls when you want to see the exact public surface produced by your configured route layout.

using DisCatSharp.Hosting.AspNetCore;
using DisCatSharp.Hosting.AspNetCore.Routing;

var urls = DiscordIngressPublicUrls.Create(
    new Uri("https://bot.example.com/base"),
    new DiscordAspNetCoreIngressOptions
    {
        RoutePrefix = "/discord-api",
        OAuthPath = "oauth2",
        OAuthCallbackPath = "complete",
        InteractionsPath = "interactions",
        WebhooksPath = "hooks",
        WebhookEventsPath = "events",
        IncomingWebhooksPath = "incoming"
    });

Console.WriteLine(urls.OAuthCallbackUrl);
Console.WriteLine(urls.InteractionsUrl);
Console.WriteLine(urls.WebhookEventsUrl);
Console.WriteLine(urls.IncomingWebhooksUrl);

This is the same path composition logic used by the validator and proxy helpers, so it is the safest way to explain "what URL does this config actually publish?"

Generate proxy snippets

Use DiscordIngressProxyHelpers to generate starter reverse-proxy configs.

Supported helpers include:

  • CreateNginxConfig(...)
  • CreateApacheConfig(...)
  • CreateDockerNginxConfig(...)
  • CreateTraefikDockerLabels(...)
  • CreateDockerCaddyConfig(...)

Example:

using DisCatSharp.Hosting.AspNetCore;
using DisCatSharp.Hosting.AspNetCore.Deployment;

var nginx = DiscordIngressProxyHelpers.CreateNginxConfig(
    new Uri("https://bot.example.com/base"),
    new Uri("http://127.0.0.1:5005/internal"),
    new DiscordAspNetCoreIngressOptions
    {
        RoutePrefix = "/discord-api"
    });

Console.WriteLine(nginx);

These helpers are intended to give you a correct starting point for:

  • forwarded headers
  • X-Forwarded-Prefix
  • path-prefix forwarding
  • mapping the public ingress root to the internal ASP.NET Core listener

Validate portal and local configuration

Use DiscordIngressConfigurationValidator to compare:

using DisCatSharp.Hosting.AspNetCore;
using DisCatSharp.Hosting.AspNetCore.Ingress;
using DisCatSharp.Hosting.AspNetCore.Ingress.OAuth;
using DisCatSharp.Hosting.AspNetCore.Validation;

var report = DiscordIngressConfigurationValidator.Validate(new DiscordIngressValidationContext
{
    PublicBaseUrl = new Uri("https://bot.example.com/base"),
    AspNetCoreOptions = new DiscordAspNetCoreIngressOptions
    {
        RoutePrefix = "/discord-api"
    },
    WebOptions = new DiscordWebIngressOptions
    {
        ApplicationVerifyKey = "YOUR_VERIFY_KEY"
    },
    OAuthOptions = new DiscordOAuthIngressOptions
    {
        ClientId = 123456789012345678,
        ClientSecret = "YOUR_CLIENT_SECRET",
        RedirectUri = "https://bot.example.com/base/discord-api/oauth/callback"
    },
    Application = application
});

if (!report.IsValid)
{
    foreach (var issue in report.Issues)
        Console.WriteLine($"{issue.Severity}: {issue.Code} - {issue.Message}");
}

This is especially useful when checking:

  • redirect URI mismatches
  • interactions endpoint mismatches
  • verify-key mismatches
  • role-connections verification URL mismatches

When to use these helpers

Use them when you are:

  • standing up ingress for the first time
  • moving behind a reverse proxy
  • switching route prefixes
  • checking production config against the Discord developer portal

For the overall package map, see Web Ingress Overview. For linked-roles verification URLs specifically, see Linked Roles.

Edit this page