enokiinc/aither repository overview

⁠Aither - Browser-Based Multiplayer Desktop Environment

Aither Web is the browser-based version of our containerized multiplayer desktop environment Aither. By utilizing tailscale, we can make this desktop accessible in the web browser of any user on the same tailscale network that it is authenticated to.

Check out our GitHub repo: https://github.com/enoki-inc/aither⁠

⁠🚀 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 Web on.

Tailscale: https://tailscale.com/⁠
Docker: https://docker-docs.netlify.app/install/⁠
Docker Compose: https://docker-docs.netlify.app/compose/install/⁠

⁠Here is a demo showcasing the installation:

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

open terminal and run

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

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-web 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 within the browser through ports 6080-6090 on any device that is authenticated on the same tailscale network using the url below:

- 0.0.0.0:<6080-6090>/vnc.html
+ <tailscale_ip>:<6080-6090>/vnc.html

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 web through this url:

<tailscale_ip>:6080/vnc.html

while user2 can connect by navigating to this url:

<tailscale_ip>:6081/vnc.html

⁠NOTE: The tradeoff of browser-based accessibility is performance isn't as smooth as viewing the desktop in a vnc viewer. However, you can improve Aither Web performance by reducing quality and maximizing compression in noVNC settings.

⁠🔑 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