Skip to Content
Settings and clean up

Settings and clean up

Open Settings with the gear next to Clean up in the popover, or Settings… in the tray menu. It has three sections: General, Machines and Clean up. Changes apply as soon as you make them, and apply to this computer. To change the limits on another machine, edit the config.toml there.

General

SettingDefaultWhat it does
Launch at loginOffStarts the app when you log in
Open Everyport⌥ ⌘ P (Ctrl Alt P)The global shortcut. Click it and press new keys, or Esc to cancel. On macOS it needs ⌥ with ⌘ or ⌃, or ⌘ and ⌃ together. On Windows and Linux it needs Alt, or Win and Ctrl together. Reset restores the default.
Scan every2 secondsHow often Everyport checks ports and processes: 1, 2, 5 or 10 seconds
Integrations → Vercel previewsOffLinks each branch to its Vercel preview. It uses the GitHub CLI (gh), which goes online.
Appearance → ModeSystemSystem, Light or Dark
Appearance → ThemeDoozy DefaultThe color theme. There are 40.

Documentation, at the bottom of General, opens these docs.

Machines

The first row is This computer. Below it are the machines you’ve added, each with its status: Not connected, Connecting…, Everyport isn’t installed, Installing Everyport…, Connected, or Can’t connect. Remove forgets a machine.

Add a machine takes a name and either a command that runs a program on the machine, such as ssh devbox, or an everyport:// connection code from everyport serve. See Remote machines.

How machines connect sums up the setup, and ? beside the title opens Connect a machine . Check beside a machine runs the connection check and shows each step, with the fix under the one that failed.

Found on this computer lists machines the app discovered: hosts in ~/.ssh/config, your Pane remote hosts, online Tailscale peers and, on Windows, WSL distros. Add saves one. WSL distros show in the app without being added.

When a machine has no everyport, Install Everyport… asks before it copies the matching binary over the same connection and checks its checksum. When the app updates, it updates the copy it installed without asking.

Clean up

Alerts

SettingDefaultOptions
Alert when a server uses more than2 GB512 MB, 1, 2, 4, 8 or 16 GB
Call it a leak when it grows by (within 10 minutes)500 MB250 MB, 500 MB, 1 GB or 2 GB

Suggest stopping servers that

Clean up in the popover suggests stopping servers that:

ReasonDefaultOptions
Had their folder or worktree deletedAlways on
Have been idle for (no CPU and no open connections)4 hours1, 2, 4, 8 or 24 hours
Have been running for3 days1, 3, 7 or 14 days
Are leaking memory, by the leak setting aboveAlways on

Auto-kill

When servers qualify decides what happens when a server starts to qualify for clean up:

ModeWhat happens
Off (default)Nothing. The server waits under Clean up.
AskA notification asks before stopping it.
Stop themThe app stops it for you.

Auto-kill acts only on a server that newly qualifies, so turning it on never stops servers that already qualified. It never stops a leaking server or a protected one. Those stay under Clean up for you to decide.

Auto-kill runs only in the desktop app, for this computer. everyport watch, the terminal UI and everyport stdio never turn it on by themselves. To stop what Clean up suggests from the terminal, run everyport clean. It asks first, unless you pass --yes.

Protected processes

Never stop lists processes that Clean up and auto-kill always skip, and that Stop and Restart ask about first. A server is protected when any process in its tree has one of these names. The defaults are postgres, redis-server, mongod, mysqld and mysql. Click × to remove one, or type a name in Add… and press Enter.

In the terminal, everyport stop and everyport restart refuse a protected server. Pass --protected to stop or restart it anyway, or everyport stop --force to kill it.

The settings files

Settings live in one folder:

OSFolder
macOS~/Library/Application Support/everyport
Windows%APPDATA%\everyport
Linux~/.config/everyport
FileHoldsUsed by
config.tomlScanning, alerts, clean up, protected processes, auto-kill, Vercel previewsThe app and the CLI
app.tomlTheme, mode and shortcutThe app
machines.tomlMachines you’ve addedThe app and everyport remote
serve-tokenThe everyport serve tokeneveryport serve

Every key in config.toml is optional. Keys you leave out take their defaults:

min_port = 3000 # the lowest port everyport shows (not in Settings) max_port = 65535 # the highest port everyport shows (not in Settings) interval_ms = 2000 alert_memory = 2147483648 # bytes leak_growth = 524288000 # bytes idle_after_secs = 14400 long_running_after_secs = 259200 protected = ["postgres", "redis-server", "mongod", "mysqld", "mysql"] auto_kill = "off" # "off", "ask" or "act" (Stop them) vercel_previews = false

The app picks up edits to the file right away. The CLI reads it when a command starts. If the file can’t be read, the app shows the error in Settings and keeps the last settings that worked, and everyport doctor names the problem. On another machine, Everyport uses that machine’s own config.toml.