Documentation / getting started

Get started with Airmsh.

Connect two devices first. Add a private service only after the host and client can see each other.

For a new user with a laptop and a second device or Linux server.

1. Install and sign in

Choose the current app or CLI package for each platform on Downloads. Sign in with your own account on each device. On a Linux server, the published installer can install the CLI and background service; inspect the script before running it.

On a laptop, install the desktop app and approve its network permission.
On the second device, install Airmsh or use the Linux CLI installer.
Sign in separately on both devices and start the private network. Confirm each appears under Devices.

2. Check the private connection

Airmsh coordinates the peer identities and tries a direct connection before relay fallback. Both devices must remain online. If one stays offline, check its app or service status before creating a resource.

3. Open one private service

On the host, start a local website or API. In Endpoints → Administration, create an Endpoint for that host, service address, private port, and protocol. Grant the intended user, group, or device. On the client, connect Endpoint access and open the exact private address shown in Endpoints.

Test denial from an account or device without the grant. Remove the grant when the test is over. Endpoint access does not enable peer Terminal or Files.

Illustrative workflow

What this looks like

Run a test app on the Linux host at 127.0.0.1:8000. Create an Endpoint whose service address is that host and port. Choose a private port such as 8080, allow your laptop, then use the name and port copied from the app. Do not substitute a public URL or assume the sample private DNS name is your organization’s name.

Limits to know

The server, client, and selected service all need to be online. DNS-over-HTTPS apps may bypass the system resolver used for private names.
For HTTPS, configure a trusted certificate on the backend; Airmsh does not issue one automatically.
Mobile store releases can lag the website build. Check the installed version before relying on a newly documented feature.

Next step

Try the workflow on your own devices.

Choose a download