enokiinc/aither-baseimage repository overview

⁠Aither - Multiplayer Desktop Environment

Aither is the first containerized multiplayer desktop environment. By utilizing tailscale, we can make this desktop accessible to any user on the same tailscale network that it is authenticated to.

⁠🚀 Installation

⁠Before starting, please make sure you have created a tailscale account and have docker and docker-compose installed on the machine you're hosting Aither on. You will also need to install a vnc viewer on the device within your tailscale network that you want to access Aither with.

Tailscale: https://tailscale.com/⁠
Docker: https://docker-docs.netlify.app/install/⁠
Docker Compose: https://docker-docs.netlify.app/compose/install/⁠
Remmina (vnc viewer for Linux): https://remmina.org/⁠
TightVNC (vnc viewer for Windows): https://www.tightvnc.com/⁠
RealVNC (vnc viewer for Mac): https://www.realvnc.com/en/⁠

⁠Here is a demo showcasing the installation:

⁠In order to get Aither up and running, please follow these instructions:

open terminal and run

git clone --branch aither-baseimage https://github.com/enoki-inc/aither.git
cd aither

within your account on tailscale's website, navigate to the auth keys page of the admin console to retrieve an emphemeral key (screenshot below)

copy the generated ephemeral key into the tailscale.env file within the aither folder

- TAILSCALE_AUTH_KEY=
+ TAILSCALE_AUTH_KEY=<your key here>

sudo docker-compose build --no-cache
sudo docker-compose up -d
sudo docker-compose exec tailscale tailscale up --authkey=$TAILSCALE_AUTH_KEY

access the desktop container through vnc ports 5900-5910 using a vnc viewer on any device that is authenticated on the same tailscale network

- 0.0.0.0:<5900-5910>
+ <tailscale_ip>:<5900-5910>

Each port is mapped to a different seat, so multiple users can work simultaneously on the containerized desktop, as long as they are accessing the desktop on different ports. For example, user1 can access aither through a vnc viewer on:

<tailscale_ip>:5900

while user2 can connect on:

<tailscale_ip>:5901

⁠🔑 Keybinds

These are basic keybinds for Aither:

⁠🔨 Troubleshooting

1. What if I get a permission denied error on entrypoint.sh when running sudo docker-compose up -d?
   You'll need to make the file executable on your local machine. On the command line, cd into the aither folder and run:

sudo chmod +x entrypoint.sh

1. When viewing Aither through vnc on my mac, why do some of my bindsym shortcuts not work?
   Certain bindsym shortcuts for aither might not work when viewing aither on a mac vnc viewer due to certain macOS key shortcuts.

⁠⏳ Star History