You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: update .checkov.yml and README.md for improved clarity
* Added `skip-path` for `node_modules/` in `.checkov.yml` to enhance configuration.
* Updated code blocks in `README.md` to specify language for better syntax highlighting.
* Improved formatting for better readability and user experience.
Copy file name to clipboardExpand all lines: README.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,10 @@ For a list of available game servers visit [linuxgsm.com](https://linuxgsm.com)
20
20
## Usage
21
21
22
22
### docker-compose
23
+
23
24
Here is an example docker-compose configuration for the "csgoserver" using the image `gameservermanagers/gameserver:csgo`. Please note that the ports may vary depending on the specific game server. More docker-compose examples are available [here](https://github.com/GameServerManagers/docker-gameserver/tree/main/docker-compose).
24
25
25
-
```
26
+
```yaml
26
27
version: '3.4'
27
28
services:
28
29
linuxgsm-csgo:
@@ -40,8 +41,10 @@ services:
40
41
```
41
42
42
43
### Docker CLI
44
+
43
45
Alternatively, you can use the Docker CLI to run the container:
44
-
```
46
+
47
+
```bash
45
48
docker run -d \
46
49
--name csgoserver \
47
50
-v /path/to/csgoserver:/data \
@@ -51,24 +54,31 @@ docker run -d \
51
54
--restart unless-stopped \
52
55
gameservermanagers/gameserver:csgo
53
56
```
57
+
54
58
### First Run
59
+
55
60
Before the first run, make sure to edit the docker-compose.yml file by changing the image tag and container_name to match your chosen game server. Upon the initial run, LinuxGSM will install the selected server and start running. The game server details will be displayed once the installation is complete.
56
61
57
62
### Game Server Ports
63
+
58
64
Each game server has specific port requirements. Therefore, after the initial run, you need to configure the appropriate ports in your docker-compose file. The required ports will be outputted after the installation process and every time the Docker container is started. Automation for this process is planned for the future.
59
65
60
66
> There are future plans to auto generate ports in the examples for you.
61
67
62
68
### Volumes
69
+
63
70
There are two types of persistent storage with Docker: volumes and bind mounts, both of which are compatible with this container. For more information on the differences between the two, please refer to the [Docker documentation](https://docs.docker.com/storage/).
64
71
65
72
Some game servers store files outside of the serverfiles directory, within other parts of the home directory. The `data` directory serves as the home directory for the LinuxGSM user and stores all game server files. Make sure to mount this directory to a persistent storage location.
66
73
67
74
### LinuxGSM User
75
+
68
76
This container uses gosu to run gameservers as the `linuxgsm` user instead of root. If you are using a bind mount for the data directory, ensure that the permissions are appropriately set.
69
77
70
78
### Run LinuxGSM commands
79
+
71
80
You can execute LinuxGSM commands within the container using the docker exec command. Here's an example to run the `./csgoserver details` command as the `linuxgsm` user:
0 commit comments