From f46298c6b84ef9d82624b7a0d55a5b86dda32693 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sat, 4 Jan 2025 11:57:04 -0600 Subject: [PATCH] Added compose example snippets for Paper docs (#3231) --- docs/index.md | 2 +- .../types-and-platforms/server-types/paper.md | 22 +++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 563c62d0..1b2bc912 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,7 +19,7 @@ where, in this case, the standard server port 25565, will be exposed on your hos !!! note - If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](#deployment-templates-and-examples) to allow for incremental reconfiguration and image upgrades. + If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](misc/deployment/index.md#on-kubernetes) to allow for incremental reconfiguration and image upgrades. !!! info diff --git a/docs/types-and-platforms/server-types/paper.md b/docs/types-and-platforms/server-types/paper.md index 9580dc79..c36ce834 100644 --- a/docs/types-and-platforms/server-types/paper.md +++ b/docs/types-and-platforms/server-types/paper.md @@ -6,6 +6,8 @@ To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "exper !!! example + Using `docker run` command line + ``` docker run ... -e TYPE=PAPER ... @@ -15,6 +17,26 @@ To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "exper docker run ... -e TYPE=PAPER -e PAPER_CHANNEL=experimental ... ``` + + Using a compose file: + + ```yaml + environment: + TYPE: PAPER + ``` + + ```yaml + environment: + TYPE: PAPER + VERSION: 1.20.6 + PAPER_BUILD: 140 + ``` + + ```yaml + environment: + TYPE: PAPER + PAPER_CHANNEL: experimental + ``` !!! tip