Documentation / Open in WinBox

Open in WinBox

Start WinBox from a device page, with the address and username filled in, and the password too if you choose.

The WinBox menu

A device's page has a WinBox menu next to Edit for operators, admins and superadmins. A viewer does not see it. (v2.6.0+)

  • Open in WinBox starts WinBox on your computer with the device's address and username filled in. You type the password in WinBox, unless an administrator lets the links carry it (see below).
  • Copy address puts the device's address on the clipboard, for typing into WinBox yourself.
  • Get WinBox Link… shows the downloads and the install command for each system.

The address is the one the manager uses for the device at that moment. While a device is reached through its backup address, WinBox opens on the backup address. The username is the one stored for the device. WinBox connects on its default port, 8291. If a router listens for WinBox on another port, copy the address and add the port in WinBox.

Installing WinBox Link

A browser can't start WinBox by itself, and WinBox doesn't register itself for links. WinBox Link is a small helper that does: install it once on each computer you use the manager from. Nothing runs in the background. It needs WinBox 4.

Download the archive for your system, unpack it, open a terminal in the unpacked folder and run the command:

SystemDownloadCommand
Windowswinbox-link-windows.zippowershell -ExecutionPolicy Bypass -File windows\install.ps1
macOSwinbox-link-macos.zipbash macos/install.sh
Linuxwinbox-link-linux.tar.gzbash linux/install.sh

WinBox is portable on Windows and Linux, so the installer looks for it in the usual places and asks when it can't find it. You can also give the path: -WinboxPath "C:\Tools\WinBox\winbox.exe" on Windows, the path as the first argument on Linux. On macOS it starts the installed WinBox app by its name. On Linux the installer needs xdg-utils, and an AppImage has to be executable.

The first time you click Open in WinBox, the browser asks whether to open the link with WinBox Link. Allow it. Chrome and Edge offer to always allow it for your manager's address.

Already installed? Nothing to do. Running the installer again updates it. Each archive also has an uninstall script next to the installer.

Windows: every user

As Administrator, add -AllUsers and the path to a WinBox every user can reach, such as one in Program Files. That installs for every user of the computer and suits Group Policy, since it never stops to ask.

Logging in with the device password

An administrator can let the links carry the password the manager uses for the device, so WinBox logs straight in: Settings → WinBox links → Put the device password in WinBox links, off by default, or WINBOX_DEVICE_PASSWORD=true in the environment.

  • Only admins and superadmins get the password in the link. Operators still type it.
  • An API key never gets it, whatever its role.
  • It is left out while a different device answers at the device's address, so the password doesn't go to the wrong box.
  • Every link with the password is recorded in Activity as "Opened WinBox with the device password".

The helper on the computer has to allow it too. Add a switch to the install command:

  • Windows: -AllowPassword
  • macOS and Linux: --allow-password

Without it, the password is dropped and WinBox asks for it. Running the installer again without the switch turns it off.

WinBox takes the password only as a command-line argument. While WinBox runs, other users of the same computer can read it from the list of processes. Turn this on for computers that are yours alone.

When a click does nothing

  • WinBox Link isn't installed on this computer. A browser gives no error for a link it has no program for. Use Get WinBox Link… from the menu.
  • The browser prompt was cancelled. Click again and allow it.
  • Windows on a managed computer. An execution policy set by Group Policy, such as AllSigned, overrides the installer's switch and the helper's script won't run. Some security software also stops a browser from starting PowerShell.
  • Linux with a browser from a snap or Flatpak, such as Firefox on Ubuntu. These open links through the desktop portal; check that xdg-desktop-portal is installed.
  • WinBox was moved. Run the installer again so it finds the new place.

Any web page can open a WinBox link, not just the manager. The browser asks first, so only allow it for addresses you trust.