MultiTunnel Contact us

Running a network

For whoever looks after a MultiTunnel network: how it is run, setting one up, and where each task is done.

How a network is run

  • No central server

    A network's members, rules and settings are kept in a signed log. Every device keeps a copy, checks every entry, and passes new ones on. We hold no copy and no keys.

  • You sign changes with your admin key

    It lives on your computer. On Windows, its security chip (the TPM) holds it behind a PIN. On Linux, it is sealed to the computer's TPM, or to the computer's own key on an encrypted disk. Every change you make, such as approving, removing, renaming or a rule, is an entry signed with it.

  • Everything is known by ID

    Networks, people and devices each have an ID. Names are labels: renaming never changes what anyone can reach, and rules are stored by ID.

  • One network never touches another

    A device can be in several networks. Each is a separate membership, with its own keys, rules and administrators.

Where you administer

On a computer that holds one of the network's admin keys, open the network in the window. Its page lets you rename its devices and people where they are listed, and has Administer, in eight parts, for everything else.

Illustration: Administer, with its eight parts as stations on a line.
Invite and approve
Make an invite, and approve the reply code a new device sends you. Invite and approve
Requests
Approve for a while, or decline, what people in the network ask to reach, and end approved access early. Requests for access
Devices
Rename a device, give it tags, set how long it stays, or remove it. People and devices
People
Add a person, rename them, merge two names for one person, or remove someone.
Services
Create a service for a server, gateway, relay or kiosk, invite a device for it, change who is responsible for it, or remove it. Services
Names
Give names, such as intranet.northwind.example, to devices in the network. Names for your services
Settings
About this network, adding devices, changing names, updates, your admin key, and the network's administrators. Several administrators
Activity
Every change made to the network: what, when and by whom, saved as CSV or JSON if you like. Activity and the audit trail

On the network's own page, as its administrator, you also find its Devices, each with Rename, and its People, each with Edit for their name, username and email. Edit network there changes the network's name, whom to ask, the line about it, its website and its short name.

Changes ask twice before they happen. Windows asks for permission first (the buttons carry a small shield), and on Windows, anything that signs asks for your admin PIN. Each button says what it does before you choose it, and what happened after.

Some tasks are done from the command line: creating a network, access rules, gateways, approving releases, the recovery key, and your plan. Each page here gives the command. Using the command line

Install MultiTunnel

Installing is done from the command line, by an administrator of the computer.

  1. Windows: make a folder only administrators can change, such as C:\Program Files\MultiTunnel-setup, and put the release's files in it: multitunnel.exe, mt-tray.exe, WebView2Loader.dll and any others it came with. The installer refuses to run from anywhere a user can write, such as Downloads.
  2. Open Terminal (Admin) and run the installer, below.
Windows
& "C:\Program Files\MultiTunnel-setup\multitunnel.exe" install -yes
Linux
sudo ./multitunnel install -yes

On Windows, it installs to C:\Program Files\MultiTunnel, starts the service, and starts the app at every sign-in. On Linux, it installs to /usr/local/lib/multitunnel, with a systemd service and the command on the path.

If your antivirus blocks MultiTunnel, add the exceptions in Your antivirus mentions MultiTunnel.

Removing MultiTunnel

On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start

Windows
& $mt remove
Linux
sudo multitunnel remove

Careful: without -keep-state, it deletes this computer's keys for every network it is in, and each network then needs a new invite to bring it back. -yes skips the questions that would warn you, so leave it out unless you're sure.

On a computer that holds a network's admin key, it refuses, unless you keep the state (-keep-state) or add -delete-keys. Deleting the key leaves only the recovery key able to change the network. Security keys and recovery

Create a network

A network is created from the command line, on the computer that will hold its admin key.

Windows
& $mt init $st northwind sam-pc sam -recovery-out E:\northwind-recovery.key
Linux
sudo multitunnel init /var/lib/multitunnel northwind sam-pc sam -account sam -recovery-out /media/usb/northwind-recovery.key
  1. Give the network's short name (northwind), this computer's name in it, and your username (sam). On Linux, or from a remote session, add -account and your own account on the computer, as below.
  2. On Windows, choose an admin PIN, at least 6 characters, and type it twice. You'll type it for every change you sign. If Windows makes the key without asking for a PIN, as some computers do, MultiTunnel says so, deletes that key, and asks for the PIN itself. On Linux there is no PIN: the key is sealed to the computer.
  3. MultiTunnel shows the recovery key once. Print it, or write it to a USB stick with -recovery-out, and lock it away. It is kept on no device. Add -passphrase to seal it with a passphrase of your choice.
  4. Confirm you have it. Nothing is saved until you do.

This computer becomes the network's administrator and first member. The network starts with one rule that lets every member reach every other (Access rules), and new devices stay members for 90 days unless you change that.

The network's membership on this computer is yours: your own account's, connected while you are signed in. Run as root on Linux, or from a remote session such as SSH or remote PowerShell, MultiTunnel can't tell whose it is: -account names your account (DOMAIN ame on Windows, or a Linux user name). Nothing is set up for everyone on a computer: every network on it is one person's, or a service's. Services

If this computer is also the network's server or gateway, move its device to a service once the network is made. Move a device to a service

Describe your network

Every device in the network gets these details, so people know whose network it is and whom to ask.

  1. Open the network, and choose Edit network. (It is also under Administer, Settings, About this network.)
  2. Fill in Name, Whom to ask (an email address or a web address), About it, Website and, if you like, Short name.
  3. Choose Save…. Windows asks for permission, then MultiTunnel asks you to go ahead, and Windows asks for your admin PIN.

The short name, such as northwind, is the end of the network's full device names, as in laptop.northwind.multitunnel. You set it once, for the whole network: every device that joins takes it, and the person joining has nothing to choose. People see the network's name, such as Northwind Clinic; the short name is under the network's Details, for anyone who types names. It uses lower-case letters, digits and hyphens.

  • If a computer already uses the short name for another network, or did within the last week, it takes a similar one, such as northwind-2, and says why once, as it joins.
  • Devices that joined before you set it keep the short name they have. Their Details offer Use the network's short name whenever it is free on that device.
  • A network without one works as before: each computer makes one from the network's name.
Command line

On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start

Windows
& $mt org-info $st northwind -name "Northwind Clinic" -contact it@northwind.example -description "The clinic and its two branches" -website https://northwind.example -short northwind
Linux
sudo multitunnel org-info /var/lib/multitunnel northwind -name "Northwind Clinic" -contact it@northwind.example -description "The clinic and its two branches" -website https://northwind.example -short northwind

With no options it shows the details. "" clears one. -short sets the network's short name (-label is its older spelling).

Your plan and its allowance

Every network has a plan, and a new network starts on the Free plan. Plans are priced per person, each with an allowance. Prices and allowances

Each device checks in with our licensing service about once a day, for each network, so paid features keep working. A check-in carries some names, such as device names and the administrator who approved the device, and which of the network's devices it connected to each day. It never carries your traffic. What a check-in carries

If a device can't reach our service, paid features carry on for 30 days. If you end a paid plan, the network carries on at the Free plan's level.

If a licence is revoked, for example for an unpaid invoice, the app warns you prominently, on the network's row and its page, and so do the rings by the clock and the command line: why, when, what it means for the network, and how to restore it. People in the network are told that it has been revoked, and that you have been told why. Security updates to MultiTunnel carry on whatever happens. Our terms say what a revocation means: If a payment fails and Suspension and revocation.

Your plan is looked after from the command line.

Command line

On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start

Your plan, its paid features and until when, the last check-in, and any notices:

Windows
& $mt licence-status $st northwind
Linux
sudo multitunnel licence-status /var/lib/multitunnel northwind

Add a paid licence we send you:

Windows
& $mt licence $st northwind "<the licence file we sent you>"
Linux
sudo multitunnel licence /var/lib/multitunnel northwind "<the licence file we sent you>"

If licence-status asks for a seat statement:

Windows
& $mt licence-seats $st northwind
Linux
sudo multitunnel licence-seats /var/lib/multitunnel northwind

Still stuck?

Email us and a person will reply. For a security problem, write to security@multitunnel.co.uk instead.

enquiries@multitunnel.co.uk