Aperture on Unraid (beta)

Unraid can’t run the installation command. It runs Aperture as an app on its Docker tab instead: one container that links your Unraid server to your panel and starts each game server as its own container. You need Unraid 6.12 or newer on a 64-bit Intel or AMD processor, with the array started and Docker turned on.

The app is new. It was built and tested against a replica of Unraid’s Docker setup, and reports from real Unraid servers are welcome: tell us how it goes on yours.

1. In your Aperture account, get the installation command and open On Unraid? under it. It shows these steps and a button that copies your one-time setup code.
2. Open Unraid’s terminal and add the app’s template:

   wget -qO /boot/config/plugins/dockerMan/templates-user/my-Aperture.xml https://aperture.sh/unraid/my-Aperture.xml

3. On the Docker tab choose Add Container and pick Aperture under Template.
4. Paste the setup code into Setup code and press Apply. The code works once and lasts 30 minutes.
5. Turn Autostart on for Aperture. Unraid then starts it with the array, and it brings back the game servers that were running.

If the app stops right after you apply, open its log from the Docker tab. The last line says what to change.

The Data folder, /mnt/user/appdata/aperture unless you change it, holds this server’s link to Aperture, every game server’s files and their local backups. Keep it, and include it in your appdata backups: without it this server can’t be linked to your panel again without help from support.

Game servers read and write their files straight on the pool or disk behind that folder, not through Unraid’s user share layer, because game installers need file operations that layer doesn’t offer. So the folder has to live on one pool or disk. Leave the appdata share on a single pool, as Unraid sets it up. If Mover has spread the folder over two disks, the app says so in its log and stops until that is fixed. Don’t use a path with spaces.

• Each game server shows up on the Docker tab as its own container, with a long name made of letters and numbers. Start, stop and change them from your panel, not from Unraid.
• Updates arrive as a new version of the app. Your panel’s Updates page tells you when there is one; apply it on the Docker tab. Game servers keep running while the app restarts.
• Players reach your games the same way as on any machine: forward each game’s ports to your Unraid server (Open your ports).

• The app needs Docker’s socket, the host’s network and the host’s view of processes and resources. The template sets all of that: it is how Wings starts game containers and reads their memory and CPU. It gives Aperture’s panel the same control over Docker on your Unraid server that the normal install gives it over a Linux machine.
• Unraid stops every container when the array stops or the server shuts down, and a running game only gets a few seconds to save. When you can, stop your game servers from your panel first.
• To remove Aperture, remove the app, remove any game containers left on the Docker tab, then delete the Data folder if you no longer want the game files.
• The app isn’t in Community Applications yet, which is why step 2 adds its template by hand.