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.

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

Improve links in README.md #330

Closed
wants to merge 1 commit into from
Closed

Improve links in README.md #330

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: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Satisfactory Server

![Satisfactory](https://raw.githubusercontent.com/wolveix/satisfactory-server/main/.github/logo.png "Satisfactory logo")
![Satisfactory](.github/logo.png "Satisfactory logo")

![Release](https://img.shields.io/github/v/release/wolveix/satisfactory-server)
![Docker Pulls](https://img.shields.io/docker/pulls/wolveix/satisfactory-server)
Expand All @@ -10,7 +10,7 @@
This is a Dockerized version of the [Satisfactory](https://store.steampowered.com/app/526870/Satisfactory/) dedicated
server.

You can alternatively try [saveshare](https://github.com/wolveix/satisfactory-server/tree/main/saveshare) instead (which
You can alternatively try [saveshare](saveshare) instead (which
relies on
client-hosting).

Expand Down Expand Up @@ -99,7 +99,7 @@ wolveix/satisfactory-server:latest
* `--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)
see [here](#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>
Expand Down Expand Up @@ -145,10 +145,10 @@ services:
### Kubernetes

If you are running a [Kubernetes](https://kubernetes.io) cluster, we do have
a [service.yaml](https://github.com/wolveix/satisfactory-server/tree/main/cluster/service.yaml)
and [statefulset.yaml](https://github.com/wolveix/satisfactory-server/tree/main/cluster/statefulset.yaml) available
under the [cluster](https://github.com/wolveix/satisfactory-server/tree/main/cluster) directory of this repo, along with
an example [values.yaml](https://github.com/wolveix/satisfactory-server/tree/main/cluster/values.yaml) file.
a [service.yaml](cluster/service.yaml)
and [statefulset.yaml](cluster/statefulset.yaml) available
under the [cluster](cluster) directory of this repo, along with
an example [values.yaml](cluster/values.yaml) file.

If you are using [Helm](https://helm.sh), you can find charts for this repo on
[ArtifactHUB](https://artifacthub.io/packages/search?ts_query_web=satisfactory&sort=relevance&page=1). The
Expand Down Expand Up @@ -233,7 +233,7 @@ really get the best out of multiplayer:
This change was made to address [permissions issues](https://github.com/wolveix/satisfactory-server/issues/44)
- The server log will show various errors; most of which can be safely ignored. As long as the container continues to
run and your log looks similar to the example log, the server should be functioning just
fine: [example log](https://github.com/wolveix/satisfactory-server/blob/main/server.log)
fine: [example log](server.log)

## Star History

Expand Down
Loading