damianisaacs/steamcmdpuckserver repository overview

⁠Setting Up a Docker Container for Puck Server

⁠Overview

The Docker image performs the following tasks:

1. Installs system updates and required packages for compatibility.
2. Installs SteamCMD to manage Steam-based game installations.
3. Downloads and sets up Puck server files using SteamCMD.
4. Configures and starts the Puck server with default environment variables.

⁠Port Configuration

To map ports, use the following command format:

-p HOST_PORT:CONTAINER_PORT/udp

⁠Important Notes

• The server requires both the default port (7777) and the next consecutive port (7778) to be open and mapped as UDP. Ensure both ports are properly forwarded.

⁠Default Environment Variables

• Server_Name: PuckServer (Default; customize this to suit your needs)
• Server_Password: "" (Default; no password)
• Server_Max: 12 (Default; maximum of 12 players)
• Server_VOIP: true (Default; VOIP enabled)
• Server_Port1: 7777 (Default port)
• Server_Port2: 7778 (Default port +1)

⁠Example Configuration Files

⁠.env File

Create an .env file with the following content to configure your server:

Server_Name=MyPuckServer
Server_Password=
Server_Max=12
Server_VOIP=true
Server_Port1=7777
Server_Port2=7778

⁠docker-compose.yml

Use the following docker-compose.yml file to manage the container:

services:
  steamcmdpuckserver:
    ports:
      - 7777:7777/udp
      - 7778:7778/udp
    container_name: PuckContainer
    environment:
      - Server_Name=MyPuckServer
      - Server_Password=
      - Server_Max=12
      - Server_VOIP=true
      - Server_Port1=7777
      - Server_Port2=7778
    restart: always
    image: damianisaacs/steamcmdpuckserver:latest

⁠Docker CLI Command

To manually run the container via CLI, use the following command:

docker run -p 7777:7777/udp -p 7778:7778/udp \
  --name PuckContainer \
  -e Server_Name=MyPuckServer \
  -e Server_Password= \
  -e Server_Max=12 \
  -e Server_VOIP=true \
  -e Server_Port1=7777 \
  -e Server_Port2=7778 \
  --restart always \
  damianisaacs/steamcmdpuckserver:latest

⁠Using Portainer

⁠Steps:

1. Create a New Container

   • Fill out the Name, Image, and Port Mapping:
     • Name: PuckContainer
     • Image: damianisaacs/steamcmdpuckserver:latest
     • Port Mapping: 7777:7777/udp and 7778:7778/udp

   

2. Edit Environment Variables

   • Go to the Env tab and set the variables to your server settings:

     Server_Name=MyPuckServer
     Server_Password=
     Server_Max=12
     Server_VOIP=true
     Server_Port1=7777
     Server_Port2=7778
     

     Copy

   

3. Deploy the Container

   • Click Deploy the Container:

   

4. Verify Configuration

   • Check the logs to ensure the environment variables are correctly applied. Look for Command line arguments in the logs:

   

⁠Troubleshooting

If you cannot see or connect to your server:

• Verify that port 7777 and port 7778 (or your selected ports) are UDP and properly forwarded.
• Ensure all server settings match the configuration files.
• Check Docker logs for errors.

⁠Additional Notes & Links

• Image Repository: Docker Hub - damianisaacs/steamcmdpuckserver⁠
• For community discussions and server sharing, visit r/Puckgame⁠.
• Puck on Steam⁠
• SteamCMD Documentation⁠