> ## Documentation Index
> Fetch the complete documentation index at: https://yoursshlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hosts

> Organize saved SSH, RDP and VNC hosts on the dashboard and configure each one in the host editor.

A **host** is a saved connection profile. You manage hosts on the **Hosts** dashboard (sidebar, **Hosts**) and edit them in the host editor.

## The hosts dashboard

![The hosts dashboard in grid view with DEMO and DEFAULT groups and four host cards](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/06-dashboard/01-grid.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=aed6ab92e1ee59ff605729ba81aa5ec9)

Grid view. Group cards sit above the host cards, and a dot shows whether a host has a live session.

The toolbar has, from left to right:

| Control | What it does |
| - | - |
| Search box | Filters hosts as you type. See [Search and filter](#search-and-filter). |
| Sort | Orders hosts. |
| Grid and list buttons | Switch the layout. |
| **Discover** | Scans your network for devices. See [Discover devices](#discover-devices). |
| **Select** | Turns on select mode for [bulk actions](https://yoursshlabs.com/user-guide/bulk-actions.md). |
| **Local terminal** | Opens a shell on your own computer. |
| **New host** | Opens the host editor. The arrow next to it adds **New group** and **Import**. |

When the window is narrower than 900 px, lower-priority controls collapse into icons or a menu.

### Grid and list

Grid view shows cards. List view shows one compact row per host. Your choice, and your sort order, are remembered between launches.

![The hosts dashboard in list view, one row per host](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/06-dashboard/02-list.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=33a7b7ab26eb4a1408588ceb286d320b)

List view.

### Sort

Open the sort menu and pick **Name A→Z**, **Name Z→A**, **Host A→Z**, **Host Z→A**, **Newest first** or **Oldest first**. The default is **Name A→Z**.

![The sort menu listing name, host and creation date orders](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/06-dashboard/03-sort-menu.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=82913bf0716650cb8da137f845413f65)

The sort menu.

### Search and filter

Type in the search box to match labels, hostnames, IPs, usernames and tags. Tokens written as `key:value` match tags of the same form. Tag a host `env:prod` and search `env:prod` to find it. Values for the same key are ORed (`env:prod env:staging`), different keys are ANDed (`env:prod role:db`).

![The dashboard filtered to the Bastion host by the search query](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/06-dashboard/04-search.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=a08b95bd1dbc53e2e9d2091a8d7bf4a9)

Searching for bastion.

When any host has a `key:value` tag, a row of filter chips appears on the left of the **N of M hosts** counter, one chip per distinct tag. Click a chip to add or remove that tag from the search.

### Groups

Click **New host**'s arrow, then **New group**, to create a group. Set a host's **Group** in the editor, or choose **Move to group** from its card menu. Click a group card to see only its hosts. Use the group card's options menu to delete a group.

### Host card menu

Double-click a card to connect. Hover it to see quick actions: **Test connection** (the pulse icon), **SFTP** (the folder icon) and the three-dot **More** menu.

![The host card menu with Connect, SFTP, Monitor, Edit, Duplicate, Copy SSH URL, Move to group, Export and Delete](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/06-dashboard/05-card-menu.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=e2c83843c889d63c8215ebce86177bb5)

The card menu.

| Item | What it does |
| - | - |
| **Connect** | Opens a session. |
| **SFTP** | Opens the file manager on this host. SSH hosts only. |
| **Monitor** | Shows live server stats. SSH hosts only. |
| **Edit** | Opens the host editor. |
| **Duplicate** | Makes a copy of the host. |
| **Copy SSH URL** | Copies a connection URL such as `ssh://user@host:port`. The scheme follows the host's protocol, and the item reads **Copy RDP URL** or **Copy VNC URL** for those hosts. |
| **Move to group** | Changes the host's group. |
| **Export** | Shows the host as `.ssh/config` text or JSON, ready to copy. |
| **Delete** | Deletes the host after a confirmation. |

![The Delete host confirmation dialog](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/06-dashboard/06-delete-confirm.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=cea2ace8a916d771b4e5679bab0c53e6)

Deleting a host asks first. Cancel is selected by default.

### Discover devices

**Discover** scans a local subnet for devices with SSH open. Pick a subnet (the app fills in your network's), click **Scan**, then click **Add** to save a result as a host or **Connect** to open a session. When you create a new host, the **Scan network to pick a device** link in the editor opens the same scan and fills the hostname with the device you pick.

### Import hosts

Open the arrow next to **New host** and choose **Import**. Pick a source tab, then choose a file or paste text, click **Parse** and review the hosts before importing. The sources are:

* **\~/.ssh**: OpenSSH config text. JSON host lists, such as the YourSSH export, are also recognized here.
* **CSV** with columns `host, label, port, username, auth_type, group, tags`
* **PuTTY**, **MobaXterm**, **SecureCRT**, **WinSCP**, **Termius** exports and **Ansible** INI inventories
* **SSH URI**: one `ssh://user@host:port` per line

CSV rows that can't be parsed are listed as warnings, not silently dropped.

## The host editor

Click **New host**, or **Edit** on a card. The editor opens as a side panel. Press `Enter` in any single-line field to save.

![The New Host panel showing the SSH, RDP and VNC switch and the general and credentials fields](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/02-add-host/01-new-host-panel.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=30609928a44dddc97fb0a8d2bd5621c6)

The host editor for an SSH host.

### Protocol

The switch at the top selects **SSH**, **RDP** or **VNC**. Changing it swaps the sections below. The port changes to the protocol's default (22, 3389, 5900) unless you already typed a custom port. RDP and VNC hosts hide the SSH-only sections. See [RDP](https://yoursshlabs.com/user-guide/rdp.md) and [VNC](https://yoursshlabs.com/user-guide/vnc.md).

### General

**Label** is the display name. **Hostname or IP** and the port sit side by side. Tab moves through label, hostname, port and username.

### Credentials and auth method

Set **Username** and **Password**, then choose an **Auth method**:

| Method | Use it when |
| - | - |
| **Password** | You sign in with a password. It is stored in the system credential store. |
| **Private Key** | You sign in with a key. Pick one under **Select key** from your [Keychain](https://yoursshlabs.com/user-guide/keychain.md). A key can carry a passphrase and an SSH certificate there. |
| **SSH Agent** | Your local agent holds the key (`SSH_AUTH_SOCK` on macOS and Linux, the OpenSSH agent pipe on Windows). |

![The Auth method dropdown with Password, Private Key and SSH Agent](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/05-more-hosts/01-auth-method-menu.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=5cc393f8bbaf71d77317093f4703eaae)

Choosing the auth method.

![The host editor with Private Key selected and a Keychain key chosen](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/05-more-hosts/03-key-auth-form.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=7c8e77fc0884e0d75fec6c32a9051dcf)

A host that uses a key from the Keychain.

### Group and tags

Choose a **Group** and add **Tags**, comma separated. Use `key:value` tags such as `env:prod, role:db` to get the search facets above.

![The Group and Tags fields at the bottom of the editor](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/02-add-host/06-section-group.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=3ea8d6480730f6cc6d4ddeeb8d3976c3)

Group and tags.

### Connection chain

The **CONNECTION CHAIN** section routes the connection through one or more jump hosts (bastions). Click **Add a Host** and pick a saved host. Repeat to add more hops. Each hop has a remove button, and **Clear** returns to a direct connection. Hosts already in the chain are not offered again, so you can't create a loop.

![The Add a Host picker listing saved hosts to use as a jump host](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/05-more-hosts/05-chain-picker.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=3c3bba5d92b6c7687bd9e5adb3a1d456)

Picking a jump host.

![The chain editor showing the Bastion hop, an arrow and the destination card](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/05-more-hosts/06-chain-with-hop.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=4042dfc8b5fe026a5d8f909936694f2d)

A chain with Bastion in front of the destination.

The terminal, SFTP, bulk actions and port forwarding all use the full chain. YourSSH verifies the [host key](https://yoursshlabs.com/user-guide/host-keys.md) of every hop. The status bar shows `via` and the first hop.

![A terminal on DB Internal with via Bastion in the status bar](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/05-more-hosts/09-chain-terminal.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=53e4da3d2f0e9d9ebc0a281d00576fcd)

Connected through Bastion.

### Proxy

The **PROXY** section sends the connection through an **HTTP CONNECT** or **SOCKS5** proxy. Enter the proxy host, port and optional username and password. Leave it on **None** for a direct connection. The proxy password is stored in the system credential store.

### SFTP mode

**SFTP MODE** chooses how the file manager starts the SFTP server on the host:

* **Default**: the normal SFTP subsystem.
* **Sudo (root)**: runs the SFTP server with `sudo`, so you can browse files owned by root.
* **Custom command**: runs the command you enter, for example `sudo /usr/lib/openssh/sftp-server`.

### Options

![The SFTP mode select and the Options switches: auto-record, redact secrets, shell integration, agent forwarding and OSC 52 clipboard](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/02-add-host/05-section-options.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=1345247c176580c42bc48b2afc081d44)

SFTP mode and per-host options.

| Option | Effect |
| - | - |
| **Auto-record sessions** | Starts a [recording](https://yoursshlabs.com/user-guide/recording.md) on every connect. |
| **Redact secrets in recordings** | Masks passwords and tokens in the recording. Needs the global setting too. |
| **Shell integration** | Reports the working directory and command status on bash and zsh. |
| **Agent forwarding** | Lets this host use your local SSH keys for onward hops, like `ssh -A`. Off by default. Only your agent signs. Private keys never leave your computer. |
| **OSC 52 clipboard** | Lets remote programs such as tmux and vim set your local clipboard. Write-only, off by default. |

> [!WARNING]
>
> Turn on **Agent forwarding** only for hosts you trust. Anyone with root on that host can use your keys while the session is open, though they can't read them.

When agent forwarding is on, a status line tells you whether YourSSH will use your system agent or fall back to Keychain keys. During a session, a key icon on the tab shows whether the host has asked for a key.

### Session template

The **SESSION TEMPLATE** section sets up each new session on this host. All fields are optional, and an empty field follows your global [settings](https://yoursshlabs.com/user-guide/settings.md).

![The Session template section with working directory, environment variables and startup snippet](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/02-add-host/04-section-template.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=e63f67b862f17cfc29598db666bcd36a)

The session template.

* **Working directory**: `cd` into this folder on connect, without echo. bash and zsh only.
* **Environment variables**: `NAME=value` pairs, exported invisibly. Names use `A–Z`, `0–9` and `_` only, and must be unique. bash and zsh only.
* **Startup snippet**: text typed visibly into the shell after setup, as if you typed it. It shows in recordings and the [audit log](https://yoursshlabs.com/user-guide/audit-log.md).
* **Theme**, **font**, **size**, **TERM** and **tmux**: per-host overrides. A distinct theme is handy for marking production hosts.

If you start typing before setup finishes, YourSSH skips the template so you keep control of the session.

### Validate, test, save, delete

The footer is always visible. Required fields show **Required**, and an out-of-range port shows **Invalid (1–65535)**. The message disappears as soon as you fix the value.

![The host editor with a Required error under the hostname field](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/02-add-host/07-validation-required.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=b72eaf3bc48f9edeb2d7734eea23b15a)

Saving with an empty hostname.

* **Test** (SSH only) connects and signs in without opening a shell. It shows **Connected** with the latency, or the error message.
* **Save** stores the host. For an existing host the button reads **Save changes**.
* **Delete** (existing hosts only) removes the host after a confirmation. Its stored password and proxy password are removed too.

![The host editor footer after a successful Test](https://mintcdn.com/your-ssh/vNM8XA5Zlrh1XSOb/images/02-add-host/10-test-result.png?fit=max\&auto=format\&n=vNM8XA5Zlrh1XSOb\&q=85\&s=27bedb23249abd4facc62bbe88ffa96c)

Test result.

## Small windows

The editor, dashboard and terminal work down to the 800 by 600 minimum window size.

![The hosts dashboard in a small window, with the toolbar collapsed to icons](https://mintcdn.com/your-ssh/hXl_1tpHLWW6nFrV/images/20-small-window/01-dashboard-900.png?fit=max\&auto=format\&n=hXl_1tpHLWW6nFrV\&q=85\&s=036f697499582309aea0558d79d77b81)

The dashboard in a 900 by 600 window.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.