# addSurrealServer

- Module: [CommunityToolkit.Aspire.Hosting.SurrealDb](/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb.md)
- Version: `13.4.0`
- Kind: `method`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire)

Adds a SurrealDB resource to the application model. A container is used for local development. The default image is and the tag is .

## Definition

```typescript
interface IDistributedApplicationBuilder {
  // ... omitted for brevity
  addSurrealServer(
    name: string,
    userName?: ParameterResource,
    password?: ParameterResource,
    port?: number,
    path?: string,
    strictMode?: boolean): SurrealDbServerResource
}
```

## Parameters

- `name` (`string`)
- `userName` (`ParameterResource`) `optional`
- `password` (`ParameterResource`) `optional`
- `port` (`number`) `optional`
- `path` (`string`) `optional` `= memory`
- `strictMode` (`boolean`) `optional` `= False`

## Returns

[SurrealDbServerResource](/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource.md) `builder`

## Applies to

- [IDistributedApplicationBuilder](/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/idistributedapplicationbuilder.md)