People and devices
Add the people in your network, name and tag their devices, set how long devices stay, and remove a device or a person.
People, devices and seats
A person
Someone in the network. Each has an ID and a display name, the name people see (such as Dana Shah). If you like, they also have a username, a short name typed in rules and commands (such as
dana), and an email. The command line calls a person a "user".A service
A server, gateway, relay or kiosk: something that isn't a person. It has a name, what it is for, and a person responsible for it. Services
A device
A computer, phone or server. Each belongs to one person, or to one service. On a computer several people use, each person who joins is a device of their own.
A seat
A person takes a seat once a device of their own is approved. Services' devices take no seat.
In the app: open the network. Its page lists its Devices, each with Rename, and its People, each with Edit. Everything else is under Administer, then People or Devices, where each row has Manage.
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
People, their devices and seats, and names that look alike:
& $mt users $st northwindsudo multitunnel users /var/lib/multitunnel northwindThe whole membership, its administrators and its rules:
& $mt devices $st northwindsudo multitunnel devices /var/lib/multitunnel northwindAdd a person
Add someone before you invite them, so their devices join as them.
- Open Administer, then People.
- Under Add a person, type their Display name as people know them and, if you like, a Username. Then choose Add person….
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
Leave out -username if they don't need one.
& $mt add-user $st northwind "Dana Shah" -username danasudo multitunnel add-user /var/lib/multitunnel northwind "Dana Shah" -username danaRename a person or a device
A person: on the network's page, choose Edit beside them under People (or Manage under Administer, People). Change their Display name, Username or Email, and choose Save….
A device: choose Rename beside it under Devices on the network's page (or Manage under Administer, Devices), type the new name, and choose Rename…. A computer whose name in the network follows its own name stops following it once you rename it.
Only names change: their devices and what they can reach stay the same. Rename back to undo.
A username belongs to one person for good. One they stop using is never given to anyone else, and they can take it back.
People can also change their own display name, username, email and device name, from their own device, unless you have turned this off. They can't change anyone else's. Change your details
To turn it off or on: Administer, Settings, under Changing names, choose Turn off… (or Let people change their own names…).
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
Give only what you're changing; "" clears one.
& $mt set-user $st northwind dana -display "Dana Shah-Clarke" -username dana.clarke -email dana@northwind.examplesudo multitunnel set-user /var/lib/multitunnel northwind dana -display "Dana Shah-Clarke" -username dana.clarke -email dana@northwind.example& $mt rename-device $st northwind dana-laptop dana-work-laptopsudo multitunnel rename-device /var/lib/multitunnel northwind dana-laptop dana-work-laptopWhether people may change their own names (on to let them again):
& $mt self-service $st northwind offsudo multitunnel self-service /var/lib/multitunnel northwind offOne person under two names, or a new ID
One person under two names takes two seats. People points out names that look alike. Merge them: the first name's devices, rules, admin rights, the services they answer for and their requests for access move to the person you choose, and the first ID is never used again. The devices carry on as they were: nobody joins again.
A new ID gives a person a fresh random ID, for example to replace an early one that was a plain name. Their devices, rules, admin rights and details move to it in one step, on any plan. Here Sam gives Priya a new ID.
Find the person
Open Administer, then People, and choose Manage beside them.
Merge into…
Under Merge into…, open Into. Choose another person to merge them into, or A new ID for them.
A new ID for them
With A new ID for them chosen, read what happens, and choose Give a new ID…. To merge into someone else instead, the button says Merge into with their name.
Go ahead?
Windows asks for permission. Then MultiTunnel says what changes: which devices move, and any access that changes. Choose Yes.
Your PIN
Windows asks for your admin PIN, in its own window.
Done
Priya is the same person under a new ID. Her devices pick it up by themselves, and she joins nothing again.
- Merging and new IDs can't be undone.
- Every computer and phone in the network needs an up-to-date MultiTunnel before a person gets a new ID. If one doesn't have it, MultiTunnel says which, and changes nothing.
- Apps that check people through MultiTunnel see the new ID from then on.
- Activity records both IDs, the old and the new. Activity and the audit trail
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
Merge one person into another, or give a person a new ID. Each shows what changes first.
& $mt merge-user $st northwind dshah danasudo multitunnel merge-user /var/lib/multitunnel northwind dshah dana& $mt merge-user $st northwind priya -new-idsudo multitunnel merge-user /var/lib/multitunnel northwind priya -new-idTags
Tags group devices for access rules, such as kiosk or servers. A tag can have a time limit: a device carrying it stays a member for at most that many days at a time, which suits contractors.
Servers, gateways, relays and kiosks belong to a service, not to a tag. Services
- Under Devices, choose Manage beside the device.
- Under Tags, tick the tags it should carry (up to 8), and choose Save tags….
- To make a tag, open Make a new tag, name it, and choose Make tag….
Before services, a tag could mark the network's own devices. Devices that carry such a tag keep its meaning until they are moved: create a service and move each one to it. Until all of them are moved, the only service changes the network takes are creating a service and moving those devices to it, and no device is newly given such a tag. Move a device to a service
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
Make a tag that keeps a device for 30 days at a time:
& $mt set-tag $st northwind contractor 30sudo multitunnel set-tag /var/lib/multitunnel northwind contractor 30Set a device's tags (it shows the access that changes, and asks first):
& $mt tag $st northwind reception-pc kiosk,serverssudo multitunnel tag /var/lib/multitunnel northwind reception-pc kiosk,serversRemove a tag that no device carries and no rule names (from the command line only):
& $mt remove-tag $st northwind contractorsudo multitunnel remove-tag /var/lib/multitunnel northwind contractorRemove a lost laptop
A removed device can no longer reach anything in the network, and the network's other devices stop accepting it. Here Sam removes Dana's lost laptop.
Find the device
Open Administer, then Devices, and choose Manage beside the device.
Remove it
Under Remove from Northwind Clinic, read what happens, and choose Remove dana-laptop…. Devices it added for its own person go with it, unless you tick to keep them.
Go ahead?
Windows asks for permission. Then MultiTunnel says again what will happen. Choose Yes.
Your PIN
Windows asks for your admin PIN, in its own window, so the PIN goes only to Windows.
Removed
The laptop can no longer reach anything in the network. If it turns up, it needs a new invite to come back.
To remove a person, choose Manage beside them under Administer, People, then Remove with their name, such as Remove Dana Shah…. Their devices go too. Services they are responsible for stay, with their devices: MultiTunnel asks who answers for those services from then on, so none is left with nobody responsible.
A device that is an administrator's: its admin key is removed in the same change, and MultiTunnel says so before you type your PIN. The computer that created the network is the exception: remove its key yourself. A lost or stolen administrator's computer
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
Remove a device; add -keep-enrolled to keep the devices it added:
& $mt revoke $st northwind dana-laptopsudo multitunnel revoke /var/lib/multitunnel northwind dana-laptopRemove a person, and their devices; add -contact and another person to pass on the services they are responsible for:
& $mt remove-user $st northwind danasudo multitunnel remove-user /var/lib/multitunnel northwind danaHow long a device stays
Give each device an end date, so a lost, stolen or copied device drops out by itself. Under Devices, choose Manage, then under How long it stays pick 30 days, 90 days, 1 year or no end date, and choose Change….
People see a warning in the app as the end nears. Extend it before then: once it ends, the device needs a new invite. New networks give new devices 90 days; you change that from the command line.
Servers, gateways and relays have no end date, as everyone they serve would lose them if they ran out. Approving one says so. Remove a lost one as you would any device, or give it an end under How long it stays if you want one. Kiosks keep the network's term, and so does a device that moves from a service to a person, from then on.
Command line
On Windows, in Terminal (Admin), once you have set $mt and $st. On Linux, in a terminal. Before you start
End a device's membership in 30 days (also 8h, 90m or never):
& $mt expire $st northwind dana-laptop 30dsudo multitunnel expire /var/lib/multitunnel northwind dana-laptop 30dHow long new devices stay (or never):
& $mt device-term $st northwind 90sudo multitunnel device-term /var/lib/multitunnel northwind 90Still stuck?
Email us and a person will reply. For a security problem, write to security@multitunnel.co.uk instead.