Skip to content

Commit 1cdc0df

Browse files
committed
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.
1 parent 50bb6be commit 1cdc0df

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

.checkov.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
skip-check:
22
- CKV_DOCKER_2
33
- CKV_DOCKER_3
4+
skip-path:
5+
- node_modules/

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ For a list of available game servers visit [linuxgsm.com](https://linuxgsm.com)
2020
## Usage
2121

2222
### docker-compose
23+
2324
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).
2425

25-
```
26+
``` yaml
2627
version: '3.4'
2728
services:
2829
linuxgsm-csgo:
@@ -40,8 +41,10 @@ services:
4041
```
4142
4243
### Docker CLI
44+
4345
Alternatively, you can use the Docker CLI to run the container:
44-
```
46+
47+
``` bash
4548
docker run -d \
4649
--name csgoserver \
4750
-v /path/to/csgoserver:/data \
@@ -51,24 +54,31 @@ docker run -d \
5154
--restart unless-stopped \
5255
gameservermanagers/gameserver:csgo
5356
```
57+
5458
### First Run
59+
5560
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.
5661

5762
### Game Server Ports
63+
5864
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.
5965

6066
> There are future plans to auto generate ports in the examples for you.
6167
6268
### Volumes
69+
6370
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/).
6471

6572
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.
6673

6774
### LinuxGSM User
75+
6876
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.
6977

7078
### Run LinuxGSM commands
79+
7180
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:
72-
```
81+
82+
``` bash
7383
docker exec -it --user linuxgsm csgoserver ./csgoserver details
7484
```

0 commit comments

Comments
 (0)