Host a skwod
A skwod lives on a computer that belongs to someone in the group. That can be your Mac, or a box that is always on. Nobody else runs it, and we never see it.
What you need to know first
- No account, no domain, no port forwarding. Your server's key is its address. Friends reach it directly when their network allows it, and through a relay that only ever carries encrypted traffic when it does not.
- Your skwod is online when your computer is. If the Mac sleeps, members see that the host is offline and reconnect by themselves later.
- Back up the data folder. It holds the key that is your server's address. Lose it and you need a new address and new invites.
- You cannot read your friends' messages. The server holds ciphertext. You can see who is a member and who posts when. See Security.
On a Mac
The Mac app is both the chat app and the server. Voice and video are included.
- Install the Mac app from the download on the home page and open it.
- Choose Start a server, type the name you want to use, and click Start server. You are signed in as the owner.
- The Invite your friends panel shows a link with Copy, Share and a QR code. Send it to your friends.
- They open the link, pick a name and ask to join. You see them under Waiting to join and click Let in.
If the macOS firewall is on, macOS asks once whether the server may accept incoming connections. Allow it so friends can connect straight to your Mac. If you deny it, skwod still works, through a relay, and is slower.
On Docker, Unraid or Synology
For a machine that is always on. One container holds the server and the voice and video server. The image is not published yet, so you build it from the source:
git clone https://github.com/FlayrLabs/skwod.git && cd skwod
docker build -t skwod-server .
SKWOD_IMAGE=skwod-server docker compose -f deploy/docker-compose.yml up -d
docker compose -f deploy/docker-compose.yml logs skwod
The log prints a one-time admin token. From a device on your own network, open
http://<the box>:3477, enter the token and press
Start server. You get an invite with a QR code. Open it on your own phone
first, because the first person in becomes the owner.
- Do not forward port 3477 on your router. The admin page is for your home network.
- There is an Unraid template in the source, at
deploy/unraid/skwod.xml.
What was tested. The container was built and run on Docker on linux/arm64, including joining, messaging and an encrypted call. An amd64 build and real Unraid and Synology boxes have not been tested yet.
On Windows or a Linux desktop
Coming soon. A small tray app that runs the server is written but has not been built or run on Windows or on a Linux desktop yet, so there is nothing to download. On Linux, the Docker image above is the tested way to host today.
The full guide
Every option, including a server with its own domain, is in docs/SELF-HOSTING.md in the source repository. The repository opens at launch, so this link may not work before then.