---
title: "LocalListener"
description: "one listener of the local server on a person's machine: the Unix domain socket or named pipe by default, and the TCP and WebSocket listeners when turned on, every one bound to the loopback address and never to a network interface; a caller proves itself with the install token in its first message"
section: concepts
address: /concepts/locallistener
contract: 0476e35e6e275db5
---

# LocalListener

one listener of the local server on a person's machine: the Unix domain socket or named pipe by default, and the TCP and WebSocket listeners when turned on, every one bound to the loopback address and never to a network interface; a caller proves itself with the install token in its first message

[figure: LocalListener is a definition at user scope. The drawing shows its fields and the objects that they point at.]

| property | value |
|---|---|
| kind | definition |
| scope | user |
| key | the app's install and the kind |
| store | postgres |
| family | network |



## Fields


| field | type | required | note |
|---|---|---|---|
| `kind` | `one of unix-socket \| named-pipe \| tcp \| websocket` | yes |  |
| `address` | `text` | yes | a path, or 127.0.0.1 with a port chosen at install |
| `enabled` | `bool` | yes | the socket always; TCP and WebSocket by a setting of the app |
| `install_token` | [VaultEntry](/concepts/vaultentry) | yes | kept in the operating system's keychain |
| `bound_to_loopback_only` | `bool` | yes | always true; a network interface fails the check |



## Routes that use it
No route takes or returns LocalListener directly. The record holds it, and the objects that point at it reach it.