Skip to content

Custom repo when installing nitrox #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FuzzyStatic merged 1 commit into from
May 25, 2026
Merged

Custom repo when installing nitrox #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ services:
image: docker.io/fuzzystatic/nitrox-server:latest
container_name: nitrox-server
volumes:
- "/path/to/nitrox:/config"
- "/path/to/subnautica:/subnautica"
- "/path/to/nitrox:/config" # Stores your server data, such as the configuration and world data
- "/path/to/subnautica:/subnautica" # Stores Subnautica's game files - you will need to copy your own game directory here by moving the contents of your Subnautica installation directory to this volume
environment:
- "PUID=1000"
- "PGID=1000"
- "TZ=Etc/UTC"
- "SUBNAUTICA_INSTALLATION_PATH=/subnautica"
- "PUID=1000" # The ID of the group to run Nitrox as (default=1000)
- "PGID=1000" # The ID of the user to run Nitrox as (default=1000)
- "TZ=Etc/UTC" # The timezone to run Nitrox with (default=Etc/UTC)
- "SUBNAUTICA_INSTALLATION_PATH=/subnautica" # The timezone to run Nitrox with (default=/subnautica)
- "SUBNAUTICA_SAVE=My World" # Set this to your desired save name (default=My World) (Optional)
- "CUSTOM_NITROX_REPOSITORY=SubnauticaNitrox/Nitrox" # Set this to the fork you want to use (default=SubnauticaNitrox/Nitrox)
ports:
- "11000:11000/udp"
- "11000:11000/udp" # Nitrox
restart: "unless-stopped"
```

Expand Down
3 changes: 2 additions & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ services:
- "PGID=1000" # The ID of the user to run Nitrox as (default=1000)
- "TZ=Etc/UTC" # The timezone to run Nitrox with (default=Etc/UTC)
- "SUBNAUTICA_INSTALLATION_PATH=/subnautica" # The timezone to run Nitrox with (default=/subnautica)
- "SUBNAUTICA_SAVE=My World" # Set this to your desired save name (default=My World)
- "SUBNAUTICA_SAVE=My World" # Set this to your desired save name (default=My World) (Optional)
- "CUSTOM_NITROX_REPOSITORY=SubnauticaNitrox/Nitrox" # Set this to the fork you want to use (default=SubnauticaNitrox/Nitrox)
ports:
- "11000:11000/udp" # Nitrox
restart: "unless-stopped"
2 changes: 1 addition & 1 deletion install-nitrox.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
echo "Downloading latest Nitrox release..."
mkdir --parents /config/packages
cd /config/packages
curl --silent https://api.github.com/repos/SubnauticaNitrox/Nitrox/releases/latest \
curl --silent https://api.github.com/repos/${CUSTOM_NITROX_REPOSITORY:-"SubnauticaNitrox/Nitrox"}/releases/latest \
| grep -wo "https.*linux_x64.zip" \
| wget --output-document ./nitrox.zip --quiet --input-file -

Expand Down
Loading