Browse docs
First connection
Get started

First connection

Sign in, add a device, create a network, and verify an observed connection.

Section
Get started
Path
/quickstart

Good for

First-time Nanami users and workspace administrators.

What you get

One device belongs to a network and its connection state is clear.

Before you start

Choose Nanami Cloud or a Self-hosted server. · Have permission to create a network or ask a workspace administrator to create one.

The same first connection applies to Nanami Cloud and Self-hosted. Deployment changes where requests go; it does not change the steps below.

1. Select the deployment

On Desktop, choose Nanami Cloud or Self-hosted. For Self-hosted, enter the server URL supplied by your administrator. A Self-hosted operator starts from the Community release package or source bundle used by the organization. Use Change server if you selected the wrong deployment.

2. Sign in

Nanami shows only methods enabled by the selected deployment:

  • email and password, with MFA when required,
  • configured SSO providers,
  • browser approval as an optional fallback.

Submitting email and password does not open a browser. Browser approval can be completed on another device by copying its URL and code. Signing in does not mean that the device is connected.

3. Add this device

Use Nanami Desktop or the CLI. The CLI path is:

bash
nanami login
nanami network list
nanami connect --network <network>
nanami status

Nanami reuses the stable identity for this installation on later sign-ins. A repeat sign-in updates the same device instead of creating another row.

4. Create or choose a network

In Client Web, open Networks. Create a network if none is available, then grant the required user or group access. Return to Desktop or the CLI and select that network.

5. Connect

Select Connect. Nanami keeps the state at Disconnected, Connecting, or Unavailable until the local runtime reports the actual result. Connect and Disconnect are never offered together.

6. Verify

Check:

  • Desktop or nanami status shows the selected network,
  • Client Web shows the device and its platform information,
  • online or offline state updates automatically,
  • Connected appears only after local runtime confirmation.

If privileged network changes cannot run on this host, Nanami shows the safe unavailable state. It does not report a successful tunnel.

Continue

Choose the most useful continuation instead of a random article.