---
title: ServeOptions
description: Where a tunnel or a port-forward listens, and when it stops on its own.
---

Where a tunnel or a port-forward listens, and when it stops on its own.

## Properties

### bind?

```ts
optional bind?: string;
```

A `host:port` to listen on. Default: loopback, on a port the OS picks; the handle's
`localAddress` says which. Bind beyond loopback only on a network you trust: whoever
connects reaches the VM with this session's credentials.

#### Default Value

```ts
"127.0.0.1:0"
```

***

### maxConnections?

```ts
optional maxConnections?: number;
```

Stop accepting after this many connections. Default: serve until stopped.

## Provenance

This page is generated from `bindings/microvms-js/index.d.ts` by TypeDoc 0.28.20 and typedoc-plugin-markdown 4.13.1, run from `site/scripts/gen-reference.mjs` on every `pnpm run sync`, so an edit made here is overwritten by the next run.

To change the page, change the doc comment in the binding's Rust source, then regenerate the declarations with `mise run dts`. `mise run dts:check` fails when the committed file no longer matches the source.