Skip to content

Commit

Permalink
Added description for server
Browse files Browse the repository at this point in the history
  • Loading branch information
Dashboy1998 committed Jan 26, 2024
1 parent 9518170 commit a3c1dd0
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ ENV PORT= \
RCON_ENABLED=true \
RCON_PORT=25575 \
QUERY_PORT=27015 \
TZ=UTC
TZ=UTC \
SERVER_DESCRIPTION=

COPY ./scripts/* /home/steam/server/
RUN chmod +x /home/steam/server/init.sh /home/steam/server/start.sh /home/steam/server/backup.sh
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ It is highly recommended you set the following environment values before startin
| PUBLIC_IP | You can manually specify the global IP address of the network on which the server running.If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | x.x.x.x |
| PUBLIC_PORT | You can manually specify the port number of the network on which the server running.If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | 1024-65535 |
| SERVER_NAME | A name for your community server | | "string" |
| SERVER_DESCRIPTION | A description for your server | | "string"

Check failure on line 124 in README.md

View workflow job for this annotation

GitHub Actions / markdownlint

Table pipe style

README.md:124:137 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md055.md
| SERVER_PASSWORD | Secure your community server with a password | | "string" |
| ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" |
| UPDATE_ON_BOOT** | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false |
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ services:
- COMMUNITY=false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!
# Enable the environment variables below if you have COMMUNITY=true
# - SERVER_NAME="World of Pals"
- SERVER_DESCRIPTION="Hello World"
volumes:
- ./palworld:/palworld/
1 change: 1 addition & 0 deletions k8s/configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ data:
# Enable the environment variables below if you have COMMUNITY=true
# SERVER_PASSWORD: "yourServerPassword"
SERVER_NAME: "Server_Name" # Note, it seems spaces are not supported, so use underlines.
SERVER_DESCRIPTION: ""
---
apiVersion: v1
kind: ConfigMap
Expand Down
4 changes: 4 additions & 0 deletions scripts/start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ if [ -n "${SERVER_NAME}" ]; then
STARTCOMMAND="${STARTCOMMAND} -servername=${SERVER_NAME}"
fi

if [ -n "${SERVER_DESCRIPTION}" ]; then
STARTCOMMAND="${STARTCOMMAND} -serverdescription=${SERVER_DESCRIPTION}"
fi

if [ -n "${SERVER_PASSWORD}" ]; then
STARTCOMMAND="${STARTCOMMAND} -serverpassword=${SERVER_PASSWORD}"
fi
Expand Down

0 comments on commit a3c1dd0

Please sign in to comment.