Skip to content

Commit

Permalink
Better docs around RAM requirements (#355)
Browse files Browse the repository at this point in the history
  • Loading branch information
wolveix committed Oct 8, 2024
1 parent de0d799 commit 48d77b9
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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<br>

</details>
Expand Down Expand Up @@ -138,7 +138,7 @@ services:
deploy:
resources:
limits:
memory: 6G
memory: 8G
reservations:
memory: 4G
```
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ services:
deploy:
resources:
limits:
memory: 6G
memory: 8G
reservations:
memory: 4G
4 changes: 2 additions & 2 deletions init.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ssl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ services:
deploy:
resources:
limits:
memory: 6G
memory: 8G
reservations:
memory: 4G

Expand Down

0 comments on commit 48d77b9

Please sign in to comment.