# RavenDBServerSettings

- Kind: `class`
- Package: [CommunityToolkit.Aspire.Hosting.RavenDB](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb.md)
- Version: `13.4.0`
- Namespace: `CommunityToolkit.Aspire.Hosting.RavenDB`
- Target framework: `net10.0`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBServerSettings.cs)

Represents the settings for configuring a RavenDB server resource.

## Definition

```csharp
namespace CommunityToolkit.Aspire.Hosting.RavenDB;

public class RavenDBServerSettings
{
    // ...
}
```

## Properties

- [ForceTcpScheme](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/properties.md#forcetcpscheme) : `bool?` `get; set` -- 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)
- [LicensingOptions](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/properties.md#licensingoptions) : [LicensingOptions?](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/licensingoptions.md) `get` -- Gets the licensing options configured for the server.
- [Port](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/properties.md#port) : `int?` `get; set` -- 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.
- [ServerUrl](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/properties.md#serverurl) : `string?` `get; set` -- The internal URL for the RavenDB server. If not specified, the container resource will automatically assign a random URL.
- [SetupMode](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/properties.md#setupmode) : [SetupMode](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/setupmode.md) `get` -- The setup mode for the server. This determines whether the server is secured, uses Let's Encrypt, or is unsecured.
- [TcpPort](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/properties.md#tcpport) : `int?` `get; set` -- Optional port to expose for the TCP endpoint (data / cluster traffic). If not set, the default 38888 is used.

## Methods

- [Secured(string, string, string?, string?, X509Certificate2?)](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/methods.md#secured-string-string-string-string-x509certificate2) : [RavenDBServerSettings](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings.md) `static` -- Creates a secured RavenDB server settings object with the specified configuration.
- [SecuredWithLetsEncrypt(string, string, string?, string?, X509Certificate2?)](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/methods.md#securedwithletsencrypt-string-string-string-string-x509certificate2) : [RavenDBServerSettings](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings.md) `static` -- Creates a secured RavenDB server settings object with the specified configuration.
- [Unsecured](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/methods.md#unsecured) : [RavenDBServerSettings](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings.md) `static` -- Creates an unsecured RavenDB server settings object with default settings.
- [WithLicense(string, bool)](/reference/api/csharp/communitytoolkit.aspire.hosting.ravendb/ravendbserversettings/methods.md#withlicense-string-bool) -- Configures licensing options for the RavenDB server.