diff --git a/README.md b/README.md index c2418f9..e693c71 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,58 @@ -

-
- LinuxGSM - LinuxGSM Docker Container -

- -[LinuxGSM](https://linuxgsm.com) is the command-line tool for quick, simple deployment and management of Linux dedicated game servers. - -> This docker container is under development is subject to significant change and not considured stable. - -A dockerised version of LinuxGSM https://linuxgsm.com - -Dockerhub https://hub.docker.com/r/gameservermanagers/linuxgsm-docker/ -# Usage - -## docker-compose -Below is an example `docker-compose` for csgoserver. Ports will vary depending upon server. - ``` -version: '3.4' -services: - linuxgsm: - build: - context: . - dockerfile: ./Dockerfile - container_name: csgoserver - environment: - - GAMESERVER=csgoserver - - LGSM_GITHUBUSER=GameServerManagers - - LGSM_GITHUBREPO=LinuxGSM - - LGSM_GITHUBBRANCH=master - volumes: - - /home/linuxgsm/serverfiles:/home/linuxgsm/serverfiles - - /home/linuxgsm/serverfiles:/home/linuxgsm/log - - /home/linuxgsm/serverfiles:/home/linuxgsm/lgsm/config-lgsm - ports: - - "27015:27015/tcp" - - "27015:27015/udp" - - "27020:27020/udp" - - "27005:27005/udp" - restart: unless-stopped -``` -# First Run -Edit the `docker-compose.yml` file changing `GAMESERVER=` to the game server of choice. -On first run linuxgsm will install your selected server and will start running. Once completed the game server details will be output. -## Game Server Ports -Each game server has its own port requirements. Becuase of this you will need to configure the correct ports in your `docker-compose` after first run. The required ports are output once installation is completed and everytime the docker container is started. -## Volumes -volumes are required to save persistant data for your game server. The example above covers a basic csgoserver however some game servers save files in other places. Please check all the correct locations are mounted to remove the risk of loosing save data. -# Run LinuxGSM commands - -Commands can be run just like standard LinuxGSM using the docker exec command. - -``` - -docker exec -it csgoserver ./csgoserver details - -``` \ No newline at end of file +

+
+ LinuxGSM + LinuxGSM Docker Container +

+ +[LinuxGSM](https://linuxgsm.com) is the command-line tool for quick, simple deployment and management of Linux dedicated game servers. + +> This docker container is under development is subject to significant change and not considured stable. + +A dockerised version of LinuxGSM https://linuxgsm.com + +Dockerhub https://hub.docker.com/r/gameservermanagers/linuxgsm-docker/ +# Usage + +## docker-compose +Below is an example `docker-compose` for csgoserver. Ports will vary depending upon server. + ``` +version: '3.4' +services: + linuxgsm: + build: + context: . + dockerfile: ./Dockerfile + container_name: csgoserver + environment: + - GAMESERVER=csgoserver + - LGSM_GITHUBUSER=GameServerManagers + - LGSM_GITHUBREPO=LinuxGSM + - LGSM_GITHUBBRANCH=master + volumes: + - /path/to/serverfiles:/home/linuxgsm/serverfiles + - /path/to/log:/home/linuxgsm/log + - /path/to/config-lgsm:/home/linuxgsm/lgsm/config-lgsm + ports: + - "27015:27015/tcp" + - "27015:27015/udp" + - "27020:27020/udp" + - "27005:27005/udp" + restart: unless-stopped +``` +# First Run +Edit the `docker-compose.yml` file changing `GAMESERVER=` to the game server of choice. +On first run linuxgsm will install your selected server and will start running. Once completed the game server details will be output. +## Game Server Ports +Each game server has its own port requirements. Becuase of this you will need to configure the correct ports in your `docker-compose` after first run. The required ports are output once installation is completed and everytime the docker container is started. +## Volumes +volumes are required to save persistant data for your game server. The example above covers a basic csgoserver however some game servers save files in other places. Please check all the correct locations are mounted to remove the risk of loosing save data. +# Run LinuxGSM commands + +Commands can be run just like standard LinuxGSM using the docker exec command. + +``` + +docker exec -it csgoserver ./csgoserver details + +``` +# \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 22f473f..a23cc44 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,9 +11,9 @@ services: - LGSM_GITHUBREPO=LinuxGSM - LGSM_GITHUBBRANCH=master volumes: - - /home/linuxgsm/serverfiles:/home/linuxgsm/serverfiles - - /home/linuxgsm/serverfiles:/home/linuxgsm/log - - /home/linuxgsm/serverfiles:/home/linuxgsm/lgsm/config-lgsm + - /path/to/serverfiles:/home/linuxgsm/serverfiles + - /path/to/log:/home/linuxgsm/log + - /path/to/config-lgsm:/home/linuxgsm/lgsm/config-lgsm ports: - "27015:27015/tcp" - "27015:27015/udp"