From 48d77b9e4b32b9c207251cec2fce8924a22b5d1e Mon Sep 17 00:00:00 2001 From: Robert Thomas <31854736+wolveix@users.noreply.github.com> Date: Tue, 8 Oct 2024 23:37:55 +0100 Subject: [PATCH] Better docs around RAM requirements (#355) --- README.md | 12 ++++++------ docker-compose.yml | 2 +- init.sh | 4 ++-- ssl/README.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b8b0315..8b3f62d 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,9 @@ Enjoy 1.0! 🎉 ## Setup -Recent updates consume 4GB - 6GB RAM, -but [the official wiki](https://satisfactory.wiki.gg/wiki/Dedicated_servers#Requirements) recommends allocating 12GB - -16GB RAM. +The server may run on less than 8GB of RAM, though 8GB - 16GB is still recommended per +the [the official wiki](https://satisfactory.wiki.gg/wiki/Dedicated_servers#Requirements). You may need to increase the +container's defined `--memory` restriction as you approach the late game (or if you're playing with many 4+ players) You'll need to bind a local directory to the Docker container's `/config` directory. This directory will hold the following directories: @@ -83,7 +83,7 @@ docker run \ --env ROOTLESS=false \ --env STEAMBETA=false \ --memory-reservation=4G \ ---memory 6G \ +--memory 8G \ --publish 7777:7777/udp \ --publish 7777:7777/tcp \ wolveix/satisfactory-server:latest @@ -102,7 +102,7 @@ wolveix/satisfactory-server:latest * For the environment (`--env`) variables please see [here](https://github.com/wolveix/satisfactory-server#environment-variables) * `--memory-reservation=4G` -> Reserves 4GB RAM from the host for the container's use -* `--memory 6G` -> Restricts the container to 6GB RAM +* `--memory 8G` -> Restricts the container to 6GB RAM * `--publish` -> Specifies the ports that the container exposes
@@ -138,7 +138,7 @@ services: deploy: resources: limits: - memory: 6G + memory: 8G reservations: memory: 4G ``` diff --git a/docker-compose.yml b/docker-compose.yml index 72d0f51..8a64e6b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -24,6 +24,6 @@ services: deploy: resources: limits: - memory: 6G + memory: 8G reservations: memory: 4G \ No newline at end of file diff --git a/init.sh b/init.sh index 0531396..9c2e848 100755 --- a/init.sh +++ b/init.sh @@ -41,8 +41,8 @@ else fi printf "Checking available memory: %sGB detected\\n" "$RAMAVAILABLE" -if [[ "$RAMAVAILABLE" -lt 12 ]]; then - printf "${MSGWARNING} You have less than the required 12GB minmum (%sGB detected) of available RAM to run the game server.\\nIt is likely that the server will fail to load properly.\\n" "$RAMAVAILABLE" +if [[ "$RAMAVAILABLE" -lt 8 ]]; then + printf "${MSGWARNING} You have less than the required 8GB minimum (%sGB detected) of available RAM to run the game server.\\nThe server will likely run fine, though may run into issues in the late game (or with 4+ players).\\n" "$RAMAVAILABLE" fi # prevent large logs from accumulating by default diff --git a/ssl/README.md b/ssl/README.md index 639773c..598666e 100644 --- a/ssl/README.md +++ b/ssl/README.md @@ -36,7 +36,7 @@ services: deploy: resources: limits: - memory: 6G + memory: 8G reservations: memory: 4G