Skip to content

Commit 38e0fb2

Browse files
authored
docs(readme): share Docker Compose file example (#118)
1 parent 599a4ca commit 38e0fb2

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ The image is under active development, with the following enhancements planned:
6262
* **Enable/Disable Aikar's flags**: Aikar's researches ([link](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/)) and [PaperMC recommendations](https://docs.papermc.io/paper/aikars-flags/)
6363
* **Configurable TimeZone**
6464
* **Support JMX**: Java Management Extensions enabling for remote management and monitoring (e.g., with [VisualVM](https://visualvm.github.io/), [JMC](https://openjdk.org/projects/jmc/), ...).
65-
* 📦 **Docker Compose**
66-
* ☸️ **Kubernetes & Helm chart**
65+
* ☸️ **Helm chart (Kubernetes)**
6766

6867
The below features may be implemented too, but are not a priority:
6968

docs/security-best-practices.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,33 @@ $ docker run -d -it \
1919
--memory=8GB \
2020
-p 25565:25565 \
2121
-e EULA=true \
22-
'djaytan/papermc-server:1.21.4'
22+
'djaytan/papermc-server:latest'
23+
```
24+
25+
or by relying on a Docker Compose file similar to the one below:
26+
27+
```yaml
28+
services:
29+
papermc-server:
30+
image: djaytan/papermc-server:latest
31+
ports:
32+
- '25565:25565'
33+
environment:
34+
EULA: 'true'
35+
mem_limit: 8GB
36+
cpus: 4
37+
restart: on-failure:3
38+
stdin_open: true
39+
tty: true
40+
privileged: false
41+
cap_drop:
42+
- ALL
43+
ulimits:
44+
nofile:
45+
soft: 16384
46+
hard: 16384
47+
nproc: 4096
48+
core: 0
2349
```
2450
2551
These settings offer sensible defaults, but you may need to adjust them based on your server's unique requirements. This documentation explains the rationale

0 commit comments

Comments
 (0)