Skip to content
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.

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

updated memory limitiations (based on update 8) #200

Merged
merged 9 commits into from
Nov 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 19 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is a Dockerized version of the [Satisfactory](https://store.steampowered.co

## Setup

According to [the official wiki](https://satisfactory.wiki.gg/wiki/Dedicated_servers#Requirements), expect to need 12GB - 16GB of RAM.
Recent updates consume 4GB - 6GB RAM, but [the official wiki](https://satisfactory.wiki.gg/wiki/Dedicated_servers#Requirements) recommends allocating 12GB - 16GB RAM.

You'll need to bind a local directory to the Docker container's `/config` directory. This directory will hold the following directories:

Expand All @@ -20,8 +20,7 @@ You'll need to bind a local directory to the Docker container's `/config` direct

Before running the server image, you should find your user ID that will be running the container. This isn't necessary in most cases, but it's good to find out regardless. If you're seeing `permission denied` errors, then this is probably why. Find your ID in `Linux` by running the `id` command. Then grab the user ID (usually something like `1000`) and pass it into the `-e PGID=1000` and `-e PUID=1000` environment variables.

Run the Satisfactory server image like this:<br>
Note: This is one command make sure to copy all of it!
Run the Satisfactory server image like this (this is one command, make sure to copy all of it):<br>

```bash
docker run \
Expand All @@ -34,28 +33,28 @@ docker run \
--env PGID=1000 \
--env PUID=1000 \
--env STEAMBETA=false \
--memory-reservation=12G \
--memory 16G \
--memory-reservation=4G \
--memory 6G \
--publish 7777:7777/udp \
--publish 15000:15000/udp \
--publish 15777:15777/udp \
wolveix/satisfactory-server:latest
```

<details>
<summary>Explanation of the command:</summary>

* `--detached` -> Starts the container detached from your terminal.<br>
If you want to see the logs replace it with `--sig-proxy=false`.
* `--name` -> Gives the container a unqiue name.
* `--hostname` -> Changes the hostname of the container.
* `--restart unless-stopped` -> Enables the restart policy that restarts the container unless it was stopped by the user.
* `--volume` -> Binds the satisfactory config folder to the folder you specified.
Allows you to easily access your savegames.
* For the environment (`--env`) variables please see [here](https://github.com/wolveix/satisfactory-server#environment-variables).
* `--memory-reservation` -> Is a memory soft limit.
* `--memory 16G` -> Limits the RAM that the container uses to 16 Gigabytes.
* `--publish` -> Specifies the ports that the container exposes.<br>
<summary>Explanation of the command</summary>

* `--detached` -> Starts the container detached from your terminal<br>
If you want to see the logs replace it with `--sig-proxy=false`
* `--name` -> Gives the container a unqiue name
* `--hostname` -> Changes the hostname of the container
* `--restart unless-stopped` -> Automatically restarts the container unless the container was manually stopped
* `--volume` -> Binds the Satisfactory config folder to the folder you specified
Allows you to easily access your savegames
* 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
* `--publish` -> Specifies the ports that the container exposes<br>
</details>

### Docker Compose
Expand Down Expand Up @@ -84,9 +83,9 @@ services:
deploy:
resources:
limits:
memory: 16G
memory: 6G
reservations:
memory: 12G
memory: 4G
```

### Kubernetes
Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ services:
deploy:
resources:
limits:
memory: 16G
memory: 6G
reservations:
memory: 12G
memory: 4G
Loading