Quickstart guide

Create an organization, put the app on your laptop, put a server on the network, open one path between them, and reach it. About five minutes.

Five minutes, start to finish

1
Create your organization
Go to app.sxaccess.com and sign in with Continue with Google, or choose Register to create an account with your email address. As long as your account belongs to no organization, the dashboard opens on Create your Organization. Give it a name of 3 to 32 lowercase letters, digits or hyphens that starts and ends with a letter or a digit, and create it. Whoever creates an organization becomes its owner. There is nothing to install on the server side: SXAccess runs the management service for you. Organizations covers creating more of them and switching between them.
2
Install the app on your laptop
On a Mac, install SXAccess from the Mac App Store or as a DMG; on Windows, download the installer from Add device in the dashboard. On a phone, it comes from the App Store or Google Play. Which client do I need? lists the requirements and the download links, and each app has its own page: macOS, Windows, iOS and Android.
3
Sign in from the app
On a Mac or a Windows PC, choose Sign in with SXAccess account. On a phone, tap Allow VPN configuration first, then Sign in. Your browser opens: sign in there, approve what the operating system asks for, and connect. Your laptop appears under Devices in the dashboard as soon as it has enrolled.
4
Add a server with the CLI
A server has nobody sitting at it, so it enrols with the CLI and an enrollment key instead of a browser sign-in. Open Access → Enrollment keys → Create enrollment key and name the key. Under Auto-assigned groups, type quickstart and press Enter: that adds a new group, which every device enrolled with the key joins. Click Create enrollment key and copy the key now, because it is shown only once.

Then install the CLI on the server. Unless you are root, the script asks for your password, so run it on its own and wait until it has finished. Install on Linux has the details.
shell
```
curl -fsSL https://pkgs.sxaccess.com/install.sh | sh
```
5
Connect the server with the key
Still on the server, connect it with the key you copied, in place of <YOUR-KEY>. It prints This device is now connected.
shell
```
sxaccess start --enrollment-key <YOUR-KEY>
```
6
Allow them to talk
Nothing can reach anything until an access rule allows it, and a rule connects groups. First put your laptop in the server's group: open Devices, click your laptop, pick quickstart under Assigned groups and click Save changes.

Then open Access → Access rules → Create access rule, give the rule a name and complete the sentence: allow quickstart to reach quickstart over ICMP. Click Create access rule. Both machines are in quickstart, so this one rule lets them ping each other and nothing more.
7
Check that they see each other
The app's Devices list on the laptop now shows the server, and sxaccess info -d on the server lists the laptop under Devices:. Before the rule, neither machine listed the other.

Open the server in the app's list: Tunnel IP is its overlay address, which the dashboard also shows in the Address column under Devices. Each organization has its own address range, so copy the address from there, put it in place of <server-address> and ping it from a terminal on the laptop. Replies from that address show that the path works.
shell
```
ping <server-address>
```

The Overview page: connected devices, enabled access rules, active routes, activity in the last 24 hours, anything that needs attention, recent activity and recently active devices. — The Overview of an organization in use. Yours shows the same tiles, with only your two devices.

What to do next

Write your first access ruleReplace the demo rule with groups, protocols and ports.Read more Add membersInvite your team by email and give each person a role.Read more Reach a private networkPublish a LAN, a VPC or a data-centre range as resources behind a routing device.Read more Set up DNSPoint devices at your own DNS servers for internal names.Read more

Undoing it

Disconnect the server with sxaccess stop and the laptop with Disconnect in the app. Both stay installed, and the server connects again the next time its service starts. To remove the CLI from a machine for good, follow the uninstall steps for Linux or macOS. Then delete the device under Devices in the dashboard, which revokes its key.