---
title: "remote in config.yaml"
url: https://devlanes.run/docs/reference/config/user/remote/
description: "Reference for the remote key in ~/.devlanes/config.yaml."
---

# remote in config.yaml

A top-level key of [`~/.devlanes/config.yaml`](/docs/reference/config/user/).

## `remote`

Type: mapping.

Settings for `devlanes remote connect`: boxes reached by a command, and how this machine serves clients when it is a box.

```yaml devlanes-user
remote:
  allow_connections: false
```

### `remote.allow_connections`

Type: boolean. Default: `true`.

Let other machines connect to this one with `devlanes remote connect`. Defaults to true. When false, every client is turned away and `devlanes daemon pair` gives no codes. Connecting from this machine to a box still works. Clients already connected stay until they disconnect. An invalid value counts as false.

```yaml devlanes-user
remote:
  allow_connections: true
```

### `remote.boxes`

Type: mapping of names to mappings.

Boxes that `devlanes remote connect <name>` reaches by running a command instead of SSH, keyed by that name. Use it for a container, a WSL distribution or a codespace. Names not listed here are SSH destinations. Changes apply at the next `remote connect`.

```yaml devlanes-user
remote:
  boxes:
    acme:
      command:
        - docker
        - exec
        - -i
        - acme
        - devlanes
        - tunnel
        - --stdio
```

### `remote.boxes.<name>`

Type: mapping.

A box that `devlanes remote connect <name>` reaches by running a command. The command must run `devlanes tunnel --stdio` in the box.

```yaml devlanes-user
remote:
  boxes:
    acme:
      command:
        - docker
        - exec
        - -i
        - acme
        - devlanes
        - tunnel
        - --stdio
```

### `remote.boxes.<name>.command`

Type: list of strings. Required.

The program and its arguments as a list, one item per argument. No shell runs it. It must run `devlanes tunnel --stdio` in the box with its input and output passed through and no terminal, so use `docker exec -i`, not `-it`. It runs again for every reconnect and cannot ask for input, so sign in to its tool first.

```yaml devlanes-user
remote:
  boxes:
    acme:
      command:
        - docker
        - exec
        - -i
        - acme
        - devlanes
        - tunnel
        - --stdio
```

### `remote.require_pairing`

Type: boolean. Default: `true`.

Serve only clients paired with this machine. Defaults to true. A client's first connection needs a one-time code from `devlanes daemon pair`, and `devlanes daemon revoke` removes a pairing. Set false to serve every client that reaches this machine over SSH or its command. An invalid value counts as true.

```yaml devlanes-user
remote:
  require_pairing: true
```

### `remote.start_daemon`

Type: boolean. Default: `true`.

Start the devlanes daemon here when a client connects and it is not running. Defaults to true. When false, a client keeps retrying until you run `devlanes daemon start` here. An invalid value counts as false.

```yaml devlanes-user
remote:
  start_daemon: true
```
