cuteminded/nitrox-server repository overview

⁠Nitrox Server Docker

A docker image that runs the Nitrox server software for the game Subnautica.

⁠Links

Visit the official Nitrox website here⁠.
You can find the original repository for this project here⁠.

⁠Tested Environments

It may work on other environments as well, but these are the ones that have been tested:

• Ubuntu 24.04 [x64]
• MacOs Tahoe [ARM64]
• Windows 11 [x64]
• Raspberry Pi OS 13 (trixie) [ARM64]
  • Raspberry Pi 4 model B
  • External SSD for storage
  • 4GB RAM

⁠Docker

To run the image using docker, use the following command:

docker run --name "nitrox" --volume "nitrox-data:/app/config/Nitrox" --volume "/path/to/subnautica:/mnt/subnautica" --publish 11000:11000/udp cuteminded/nitrox-server

⁠Docker-Compose

To run the image using docker-compose, adjust this docker-compose file to your needs:

services:
  nitrox:
    image: "cuteminded/nitrox-server:latest"
    restart: "unless-stopped"
    tty: true
    stdin_open: true
    ports:
      - "11000:11000/udp" # Nitrox Game Port
      - "50000:50000" # GUI Config Editor Port (if enabled)
    environment:
      TZ: "Etc/UTC"
      SUBNAUTICA_INSTALLATION_PATH: "/mnt/subnautica"
    volumes:
      - "nitrox-data:/app/config/Nitrox"
      - "/path/to/subnautica:/mnt/subnautica"
volumes:
  nitrox-data: 

Place the docker-compose.yml file somewhere on your server and run docker-compose up in the same directory to start the server.
Replace /path/to/subnautica with the path to the Subnautica installation directory, for Steam this will be something like: /path/to/steam/steamapps/common/Subnautica.
Set the timezone to your own for proper timestamps in the logs.

⁠Server Configuration

You can find your server files including the configuration files in the nitrox-data volume.
Docker volumes are usually stored in /var/lib/docker/volumes.

⁠GUI Config Editor

The image includes a web-based GUI config editor for editing the server configuration file.

⁠Enabling the Config Editor

-e CONFIG_EDITOR=true -e CONFIG_EDITOR_USER=yourusername -e CONFIG_EDITOR_PASS=yourpassword

⁠Disclaimer

This project is an unofficial Docker/containerization project for Nitrox.

Nitrox is developed by the Nitrox team: https://github.com/SubnauticaNitrox/Nitrox⁠

This repository is not affiliated with, endorsed by, or associated with the Nitrox developers, Unknown Worlds Entertainment, or Subnautica.