RavenDBServerSettings Methods

ClassMethods4 members

Represents the settings for configuring a RavenDB server resource.

Secured(string, string, string?, string?, X509Certificate2?)staticRavenDBServerSettings

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

public class RavenDBServerSettings
{
    public static RavenDBServerSettings Secured(
        string domainUrl,
        string certificatePath,
        string? certificatePassword = null,
        string? serverUrl = null,
        X509Certificate2? clientCertificate = null)
    {
        // ...
    }
}

RavenDBServerSettings.cs#L67-L72

Parameters

domainUrlstringThe public domain URL for the server.

certificatePathstringThe path to the certificate file.

certificatePasswordstring?optionalThe password for the certificate file, if required. Optional.

serverUrlstring?optionalThe optional server URL.

clientCertificateX509Certificate2?optionalOptional client certificate used by management code (health checks, ensure-database, etc.) when connecting to a secured RavenDB instance.

SecuredWithLetsEncrypt(string, string, string?, string?, X509Certificate2?)staticRavenDBServerSettings

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

public class RavenDBServerSettings
{
    public static RavenDBServerSettings SecuredWithLetsEncrypt(
        string domainUrl,
        string certificatePath,
        string? certificatePassword = null,
        string? serverUrl = null,
        X509Certificate2? clientCertificate = null)
    {
        // ...
    }
}

RavenDBServerSettings.cs#L87-L92

Parameters

domainUrlstringThe public domain URL for the server.

certificatePathstringThe path to the certificate file.

certificatePasswordstring?optionalThe password for the certificate file, if required. Optional.

serverUrlstring?optionalThe optional server URL.

clientCertificateX509Certificate2?optionalOptional client certificate used by management code (health checks, ensure-database, etc.) when connecting to a secured RavenDB instance.

UnsecuredstaticRavenDBServerSettings

Creates an unsecured RavenDB server settings object with default settings.

public class RavenDBServerSettings
{
    public static RavenDBServerSettings Unsecured()
    {
        // ...
    }
}

RavenDBServerSettings.cs#L53

WithLicense(string, bool)

Configures licensing options for the RavenDB server.

public class RavenDBServerSettings
{
    public void WithLicense(
        string license,
        bool eulaAccepted = true)
    {
        // ...
    }
}

RavenDBServerSettings.cs#L102-L103

Parameters

licensestringThe license string for the RavenDB server.

eulaAcceptedbooloptionalIndicates whether the End User License Agreement (EULA) has been accepted. Defaults to true.