RavenDBServerSettings

Classnet10.0

📦 CommunityToolkit.Aspire.Hosting.RavenDB v13.5.0

Represents the settings for configuring a RavenDB server resource.

namespace CommunityToolkit.Aspire.Hosting.RavenDB;

public class RavenDBServerSettings
{
    // ...
}

10 members

Properties6

ForceTcpSchemeget; set

bool?

Advanced/debug optional parameter that forces the TCP scheme for the RavenDB server URL. Useful for deployment scenarios with constrained http(s):// schema usage (e.g., only port 80 can use http)

LicensingOptionsget

LicensingOptions?

Gets the licensing options configured for the server.

Portget; set

int?

Optional port to expose for the HTTP endpoint (Studio / REST API). If not set, Aspire will automatically assign a free port on the host at runtime.

ServerUrlget; set

string?

The internal URL for the RavenDB server. If not specified, the container resource will automatically assign a random URL.

SetupModeget

SetupMode

The setup mode for the server. This determines whether the server is secured, uses Let's Encrypt, or is unsecured.

TcpPortget; set

int?

Optional port to expose for the TCP endpoint (data / cluster traffic). If not set, the default 38888 is used.

View all properties

Methods4

Secured(string, string, string?, string?, X509Certificate2?)static

RavenDBServerSettings

Creates a secured RavenDB server settings object with the specified configuration.

SecuredWithLetsEncrypt(string, string, string?, string?, X509Certificate2?)static

RavenDBServerSettings

Creates a secured RavenDB server settings object with the specified configuration.

Unsecuredstatic

RavenDBServerSettings

Creates an unsecured RavenDB server settings object with default settings.

WithLicense(string, bool)

Configures licensing options for the RavenDB server.

View all methods