Quick Setup

You have a server. We think you may want to know how to get it cooking.

We assume you didn’t get into this industry to configure gear, so this guide is intentionally brief. After this, if you have more questions, navigate to the other pages that have deeper dives into each feature.

This guide presumes that you’ve already done the hardware setup and powered on.

Get the App Up

We’ll find the IP address of the server and open the UI in the browser. You can also connect via the mDNS resolved address: https:/sndwrks-server-<number>.

Note

When you first connect the browser, you’ll see a note about the certificate not being trusted. This is because we generate the certificates on the server.

We made this choice so you wouldn’t need internet to connect to the server securely.

Go ahead and tell the browser it’s ok to trust the website.

1. Plug it in
   Hook up Port 8 (server) or Port 2 (smol) either into your network or directly to a computer.
2. Find it on the network
   There are two options: Link-local or DHCP.
   Link Local
   If you don’t have DHCP or are plugged in directly, this port has a link-local address assigned of 169.254.1.1. If your computer doesn’t have a link-local address, set one like 169.254.1.99.
   DHCP
   If you’re plugging into the network with DHCP, this port is defaulted to have DHCP enabled and it will (hopefully) an IP address. Use an IP scanner to find the server or look in your DHCP server to see the address.

3. Open the web app
   Use the IP address from Step 2 (either the DHCP address or 169.254.1.1) and type that into a browser or type in the resolved mDNS address https://sndwrks-server-<number>.
4. Sign in
   The first screen you’ll meet is the sign-in gate. If you already have an account, sign in. If not, click Register and enter the three-word magic code from the system page in the cloud app. The magic code is shown in the admin panel for your system. More on this in Users & Permissions.
5. Celebrate?
   You should land on the homepage of the server website. If not, well heck. We’d recommend confirming your computer network settings, cabling, and the address in the browser. If you’re still having trouble reach out on Discord or our Contact page.

Server Homepage

This is close to what you should see: the overview page, opening on the analytics tab.

Tip

We recommend Firefox for various reasons: great privacy, it doesn’t use chromium, and it’s open-source.

Note

If the app ever loses touch with the server, you’ll see a “server disconnected” screen with links to reconnect. It’ll sort itself out once the server is back.

IP Address Setup

Now, let’s get the server setup to talk to your network.

We recommend that if you’re using DHCP you reserve the IP Address in your DHCP server otherwise just set a static ip address.

1. Navigate to the settings page
2. Select the Server panel
3. Select the interface you’d like to configure
4. Add the network options that make sense: DHCP, VLANs etc.

Network Configuration Page

Add a Device (or more)

The devices feature is the core of the software. This is how the server knows what it can communicate with.

There’s two ways to add devices.

1. Add manually. We recommend this path if you only want to add one or two devices now.
2. Add from the network scanner. We recommend this path if you have lots of devices.

Add manually

1. Navigate to the devices page
2. Click + New
3. Fill out the bits
4. Hit Enter or click Save

New Device Page

Add via network scanner

1. Navigate to the utilities page
2. Select the network tab if not selected
3. Open the available networks page to add a subnet or add a network to scan
4. Select your scan speed (see the disclaimer about scan speeds there, please don’t Blast a network that isn’t yours. Ask Cody Spencer about that one time at the Ahmanson)
5. Run the scan
6. Select the subnet you’d like to add devices from if you scanned multiple
7. Click add devices.

New Device from Scan

Wrapping Up

You did it! The server was setup. Hopefully, that was quick. Now you can take the devices you added and do stuff with them like add them to macros or the router.

Devices The core of the system.

Macros Control everything.

Router Wire sources to destinations.

Haze Watch Put a number to the look.

Utility Little tools to make life easier.