Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm groups every target host into an entry — a saved connection record that stores the protocol, address, credentials, and display settings for a server. Entries live in your sidebar alongside folders and organization workspaces, so you can reach any host in a couple of clicks.

​
Supported protocols

SSH

Secure Shell connections to Linux and Unix hosts. Rendered in a full browser terminal.

Telnet

Unencrypted terminal connections for legacy systems. Also rendered in the terminal view.

RDP

Remote Desktop Protocol for Windows hosts. Rendered via Apache Guacamole.

VNC

Virtual Network Computing for graphical desktop access. Rendered via Apache Guacamole.

PVE Shell

Direct shell access to a Proxmox VE node, routed through your Proxmox integration.

PVE LXC

Console access to a Proxmox LXC container, routed through your Proxmox integration.
SSH and Telnet entries use the built-in terminal renderer. RDP and VNC entries use the Guacamole-based graphical renderer. Proxmox entry types (pve-shell, pve-lxc, pve-qemu) are linked to a configured Proxmox integration rather than a standalone host.

​
Adding a connection

1

Open the new entry dialog

Click the + button in the sidebar or select New server from the context menu of any folder.
2

Fill in the basic details

Provide a name, choose a protocol (ssh, telnet, rdp, or vnc), and enter the host IP address and port.
{
  "name": "prod-web-01",
  "config": {
    "protocol": "ssh",
    "ip": "10.0.1.10",
    "port": 22
  }
}
3

Assign an identity (optional)

Select one or more saved identities that contain the credentials for this host. The first identity in the list becomes the default. See Identities below for details.
4

Choose a folder (optional)

Pick an existing folder to place the entry in, or leave the field empty to add it at the root level. Entries inside an organization folder are automatically scoped to that organization.
5

Save

Click Create. The entry appears in the sidebar immediately and you can open a session by clicking it.
The icon field defaults to server when left blank. You can change it to any supported icon name after creating the entry.

​
Identities

An identity stores authentication credentials independently from any single server entry, so you can reuse the same credentials across many connections.

​
Identity types

Stores a username and password. Use this for password-based SSH authentication or for RDP/VNC logins.

​
Identity scope

Identities can be personal (visible only to you) or organization-scoped (shared with every member of the organization). When you move an entry between organizations, Nexterm automatically removes any identities that no longer belong to the target organization.

​
Assigning identities to an entry

You can assign multiple identities to a single entry. The first identity in the list is used by default; you can pick a different one at connection time. Only identities you have access to — personal or from your active organizations — are shown in the selector.

​
Folders

Folders let you group related entries into a hierarchy in the sidebar.
  • Create a folder from the sidebar + menu and give it a name.
  • Drag entries into folders, or set folderId when creating or editing an entry.
  • Folders can be renamed or deleted. Deleting a folder does not delete the entries inside it; those entries move to an unfiled state.
  • Organization folders appear automatically when you are a member of an organization and contain that organization’s entries.

​
Tags

Tags let you apply color-coded labels to entries for cross-folder categorization.
1

Create a tag

Go to Settings → Tags and create a tag with a name and a color.
2

Assign to entries

Open an entry’s context menu and choose Manage tags, or use the tag assignment API endpoint POST /tag/{tagId}/assign/{entryId}.
3

Filter by tag

Use the tag filter in the sidebar to show only entries that carry a specific tag.
Tags are personal — they belong to your account and are not shared with organizations.

​
Wake-on-LAN

If a server supports Wake-on-LAN, you can power it on directly from Nexterm without a separate tool.
1

Add the MAC address

Edit the entry and enter the server’s MAC address in the MAC address field. The expected format is AA:BB:CC:DD:EE:FF.
{
  "config": {
    "macAddress": "AA:BB:CC:DD:EE:FF",
    "wakeOnLanEnabled": true
  }
}
2

Send the magic packet

Right-click the entry in the sidebar and choose Wake server, or use the API endpoint POST /entry/{entryId}/wake. Nexterm sends a WoL magic packet to the configured address.
Wake-on-LAN only works for entries of type server. Entries without a saved MAC address will return an error when you attempt to wake them.

​
Importing an SSH config file

If you already have a ~/.ssh/config file with many hosts, you can bulk-import them into Nexterm rather than creating entries one by one.
1

Open the import dialog

In the sidebar, click Import → SSH config.
2

Paste or upload your config

The UI parses your SSH config file and shows a preview of the hosts it found.
3

Choose a destination folder

Select the folder where imported entries should be placed. If the folder belongs to an organization, entries are imported as organization-scoped entries.
4

Map identities (optional)

Assign existing identities to hosts before importing. Each host in servers can carry an identities array of identity IDs.
5

Confirm

Click Import. The server reports how many entries were imported, how many were skipped (because an entry with the same name already exists in the target folder), and how many failed.
Duplicate detection is based on the entry name and target folder. If an entry with the same name already exists in the selected folder, that host is skipped — not overwritten.

​
Duplicating an entry

To create a copy of an existing entry — for example to clone a server config for a staging host — right-click the entry and choose Duplicate. The new entry is created with the same configuration and all the same identity assignments, and its name is suffixed with (Copy).

​
Recent connections

The sidebar Recent section shows the last five servers you connected to (SSH, SFTP, RDP, VNC, and Proxmox connections all count). You can change the limit by passing ?limit=N to the GET /entry/recent endpoint. Recent connections are derived from audit logs, so only connections that produced an audit event appear in the list.

​
Multi-tab sessions

You can open multiple server sessions in parallel inside the Nexterm UI. Each session runs in its own tab. Tabs are independent — closing one does not affect the others. This is particularly useful when you need to work on several hosts simultaneously or compare outputs side by side.

​
Repositioning entries

Entries within a folder — or at the root level — can be reordered by dragging them to a new position. You can also move an entry into a different folder or organization by dragging it across the sidebar. When an entry is moved into a different organization, any identities that belonged to the previous organization are automatically removed from that entry.

Build docs developers (and LLMs) love

Get started for freeTalk to us