Updated README.md

This commit is contained in:
William Miceli
2024-02-11 17:13:05 -05:00
parent 1e88f9ccc9
commit 48f55cd86c
3 changed files with 102 additions and 4 deletions

View File

@@ -7,6 +7,7 @@ trigger:
- main - main
event: event:
- push - push
- tag
services: services:
- name: docker - name: docker
@@ -51,6 +52,9 @@ steps:
- source /scratch/EXTRA_ENVIRONMENT - source /scratch/EXTRA_ENVIRONMENT
- echo $GITEA_TOKEN | docker login git.williammiceli.systems --username $GITEA_USERNAME --password-stdin - echo $GITEA_TOKEN | docker login git.williammiceli.systems --username $GITEA_USERNAME --password-stdin
- docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:latest - docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:latest
- if [ -n "$DRONE_SEMVER" ]; then docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:${DRONE_SEMVER_MAJOR}; fi
- if [ -n "$DRONE_SEMVER" ]; then docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:${DRONE_SEMVER_MAJOR}.${DRONE_SEMVER_MINOR}; fi
- if [ -n "$DRONE_SEMVER" ]; then docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:${DRONE_SEMVER_MAJOR}.${DRONE_SEMVER_MINOR}.${DRONE_SEMVER_PATCH}; fi
- docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:app_build_id$${APP_BUILD_ID} - docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:app_build_id$${APP_BUILD_ID}
- docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:ci_build${DRONE_BUILD_NUMBER} - docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:ci_build${DRONE_BUILD_NUMBER}
- docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:commit_sha${DRONE_COMMIT_SHA:0:12} - docker image tag image:latest git.williammiceli.systems/william/docker_satisfactory-server:commit_sha${DRONE_COMMIT_SHA:0:12}
@@ -75,6 +79,9 @@ steps:
- source /scratch/EXTRA_ENVIRONMENT - source /scratch/EXTRA_ENVIRONMENT
- echo $DOCKER_TOKEN | docker login docker.io --username $DOCKER_USERNAME --password-stdin - echo $DOCKER_TOKEN | docker login docker.io --username $DOCKER_USERNAME --password-stdin
- docker image tag image:latest docker.io/williammiceli/satisfactory-server:latest - docker image tag image:latest docker.io/williammiceli/satisfactory-server:latest
- if [ -n "$DRONE_SEMVER" ]; then docker image tag image:latest docker.io/williammiceli/satisfactory-server:${DRONE_SEMVER_MAJOR}; fi
- if [ -n "$DRONE_SEMVER" ]; then docker image tag image:latest docker.io/williammiceli/satisfactory-server:${DRONE_SEMVER_MAJOR}.${DRONE_SEMVER_MINOR}; fi
- if [ -n "$DRONE_SEMVER" ]; then docker image tag image:latest docker.io/williammiceli/satisfactory-server:${DRONE_SEMVER_MAJOR}.${DRONE_SEMVER_MINOR}.${DRONE_SEMVER_PATCH}; fi
- docker image tag image:latest docker.io/williammiceli/satisfactory-server:app_build_id$${APP_BUILD_ID} - docker image tag image:latest docker.io/williammiceli/satisfactory-server:app_build_id$${APP_BUILD_ID}
- docker image tag image:latest docker.io/williammiceli/satisfactory-server:ci_build${DRONE_BUILD_NUMBER} - docker image tag image:latest docker.io/williammiceli/satisfactory-server:ci_build${DRONE_BUILD_NUMBER}
- docker image tag image:latest docker.io/williammiceli/satisfactory-server:commit_sha${DRONE_COMMIT_SHA:0:12} - docker image tag image:latest docker.io/williammiceli/satisfactory-server:commit_sha${DRONE_COMMIT_SHA:0:12}

View File

@@ -13,7 +13,7 @@ RUN dpkg --add-architecture i386 && \
apt-get install -y --no-install-recommends ca-certificates locales steamcmd && \ apt-get install -y --no-install-recommends ca-certificates locales steamcmd && \
ln -s /usr/games/steamcmd /usr/bin/steamcmd && \ ln -s /usr/games/steamcmd /usr/bin/steamcmd && \
apt-get clean && \ apt-get clean && \
rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/*
# Add unicode support # Add unicode support
RUN locale-gen en_US.UTF-8 RUN locale-gen en_US.UTF-8
@@ -41,4 +41,10 @@ EXPOSE 7777/udp 15000/udp 15777/udp
VOLUME ["/home/steam/.config/Epic/FactoryGame/Saved"] VOLUME ["/home/steam/.config/Epic/FactoryGame/Saved"]
# Start command for the server # Start command for the server
CMD ["/home/steam/satisfactory_server/FactoryServer.sh"] CMD ["/home/steam/satisfactory_server/FactoryServer.sh"]
# Labels
LABEL org.opencontainers.image.authors="William Miceli; https://github.com/WilliamMiceli; https://williammiceli.me"
LABEL org.opencontainers.image.source=https://github.com/WilliamMiceli/Docker_Satisfactory-Server
LABEL org.opencontainers.image.revision=${DRONE_COMMIT_SHA}
LABEL org.opencontainers.image.created=${DRONE_BUILD_STARTED}

View File

@@ -1,6 +1,91 @@
[![Build Status](https://drone.williammiceli.systems/api/badges/William/Docker_Satisfactory-Server/status.svg)](https://drone.williammiceli.systems/William/Docker_Satisfactory-Server) [![Drone Build Status](https://img.shields.io/drone/build/William/Docker_Satisfactory-Server?server=https%3A%2F%2Fdrone.williammiceli.systems&style=for-the-badge&label=Build%20Status)](https://drone.williammiceli.systems/William/Docker_Satisfactory-Server)
[![Docker Image Size](https://img.shields.io/docker/image-size/williammiceli/satisfactory-server?style=for-the-badge)](https://hub.docker.com/r/williammiceli/satisfactory-server)
# Useful References ![Satisfactory Logo](https://img2.storyblok.com/fit-in/0x300/filters:format(webp)/f/110098/5405x1416/10decfbcac/hero-logo.png)
# Docker Image - Satisfactory Server
[Game Website](https://www.satisfactorygame.com/)
# Usage
## Public Image Repository
[Docker Hub](https://hub.docker.com/r/williammiceli/satisfactory-server)
## Running This Image
### One-line (Useful for Testing)
```sh
docker run -d -p 7777:7777/udp -p 15000:15000/udp -p 15777:15777/udp -v /path/to/your/data:/home/steam/.config/Epic/FactoryGame/Saved williammiceli/satisfactory-server:latest
```
### Docker Compose
#### Create compose file
Create 'docker-compose.yaml' using the following as example/template:
```yaml
version: '3.8'
services:
satisfactory-server:
image: docker.io/williammiceli/satisfactory-server:latest
ports:
- "7777:7777/udp"
- "15000:15000/udp"
- "15777:15777/udp"
volumes:
- type: bind
source: ./data # Path to your local directory for server data
target: /home/steam/.config/Epic/FactoryGame/Saved
restart: unless-stopped
```
#### Starting Container
While in same directory of your 'docker-compose.yaml':
```sh
docker compose up -d
```
#### Stopping Container
While in same directory of your 'docker-compose.yaml':
```sh
docker compose down
```
## Updating The App
### Pull Newest Image
```sh
docker image pull williammiceli/satisfactory-server:latest
```
### Use SteamCMD In Running Container
```sh
steamcmd +force_install_dir /home/steam/satisfactory_server +login anonymous +app_update 1690800 -beta public validate +quit
```
![Player Thumbs Up](https://img2.storyblok.com/fit-in/0x800/filters:format(png)/f/110098/600x730/99e92fe34f/hero-graphic.png)
# Meta
* [Build System](https://drone.williammiceli.systems/William/Docker_Satisfactory-Server)
## Credits for Useful References
* https://openai.com/chatgpt * https://openai.com/chatgpt
* https://github.com/steamcmd/docker * https://github.com/steamcmd/docker