mirror of
https://github.com/itzg/docker-minecraft-server.git
synced 2026-03-03 21:36:24 +00:00
docs: mkdocs cleanup and caught up with latest README changes (#2155)
This commit is contained in:
16
docs/misc/contributing/docs.md
Normal file
16
docs/misc/contributing/docs.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Site documentation
|
||||
|
||||
The documentation for this image/repository is written in markdown and built by [MkDocs](https://www.mkdocs.org/) into a documentation website hosted at [Read the Docs](https://readthedocs.org/). [Here is general information about writing MkDocs markdown](https://www.mkdocs.org/user-guide/writing-your-docs/) and [specifics for the Material theme used](https://squidfunk.github.io/mkdocs-material/reference/).
|
||||
|
||||
!!! note
|
||||
The README.md rarely needs to be modified and only serves as a brief introduction to the project.
|
||||
|
||||
The documentation source is maintained in the [docs](https://github.com/itzg/docker-minecraft-server/tree/master/docs) folder and is organized into sections by directory and files. Look through the existing content to determine if an existing file should be updated or a new file/directory added.
|
||||
|
||||
It will be very helpful to view the rendered documentation as you're editing. To do that run the following from the top-level directory:
|
||||
|
||||
```shell
|
||||
docker compose -f docker-compose-mkdocs.yml -p mkdocs up
|
||||
```
|
||||
|
||||
You can access the live documentation rendering at <http://localhost:8000>.
|
||||
1
docs/misc/deployment/aws.md
Normal file
1
docs/misc/deployment/aws.md
Normal file
@@ -0,0 +1 @@
|
||||
If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use.
|
||||
26
docs/misc/deployment/docker-compose.md
Normal file
26
docs/misc/deployment/docker-compose.md
Normal file
@@ -0,0 +1,26 @@
|
||||
Rather than type the server options below, the port mappings above, etc
|
||||
every time you want to create new Minecraft server, you can now use
|
||||
[Docker Compose](https://docs.docker.com/compose/). Start with a
|
||||
`docker-compose.yml` file like the following:
|
||||
|
||||
``` yaml
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
mc:
|
||||
image: itzg/minecraft-server
|
||||
ports:
|
||||
- 25565:25565
|
||||
environment:
|
||||
EULA: "TRUE"
|
||||
tty: true
|
||||
stdin_open: true
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
and in the same directory as that file run
|
||||
|
||||
docker-compose up -d
|
||||
|
||||
Now, go play...or adjust the `environment` section to configure
|
||||
this server instance.
|
||||
8
docs/misc/deployment/helmcharts.md
Normal file
8
docs/misc/deployment/helmcharts.md
Normal file
@@ -0,0 +1,8 @@
|
||||
- itzg Helm Chart:
|
||||
- [GitHub repo](https://github.com/itzg/minecraft-server-charts)
|
||||
- [Helm Chart repo](https://itzg.github.io/minecraft-server-charts/)
|
||||
- [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts)
|
||||
|
||||
### Examples
|
||||
|
||||
The [examples directory](https://github.com/itzg/docker-minecraft-server/tree/master/examples) also provides examples of deploying the [itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server/) Docker image.
|
||||
@@ -1,3 +1,5 @@
|
||||
# Running on RaspberryPi
|
||||
|
||||
To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags [list in the Java version section](../versions/java.md) that specify `armv7` for the architecture, which includes `itzg/minecraft-server:latest`.
|
||||
|
||||
!!! note
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
[RCON](http://wiki.vg/RCON) is enabled by default, so you can `exec` into the container to
|
||||
access the Minecraft server console:
|
||||
|
||||
```
|
||||
docker exec -i mc rcon-cli
|
||||
```
|
||||
|
||||
Note: The `-i` is required for interactive use of rcon-cli.
|
||||
|
||||
To run a simple, one-shot command, such as stopping a Minecraft server, pass the command as arguments to `rcon-cli`, such as:
|
||||
|
||||
```
|
||||
docker exec mc rcon-cli stop
|
||||
```
|
||||
|
||||
_The `-i` is not needed in this case._
|
||||
|
||||
If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script. For example, a player can be op'ed in the container `mc` with:
|
||||
|
||||
```shell
|
||||
docker exec mc mc-send-to-console op player
|
||||
| |
|
||||
+- container name +- Minecraft commands start here
|
||||
```
|
||||
|
||||
In order to attach and interact with the Minecraft server, add `-it` when starting the container, such as
|
||||
|
||||
docker run -d -it -p 25565:25565 --name mc itzg/minecraft-server
|
||||
|
||||
With that you can attach and interact at any time using
|
||||
|
||||
docker attach mc
|
||||
|
||||
and then Control-p Control-q to **detach**.
|
||||
|
||||
For remote access, configure your Docker daemon to use a `tcp` socket (such as `-H tcp://0.0.0.0:2375`)
|
||||
and attach from another machine:
|
||||
|
||||
docker -H $HOST:2375 attach mc
|
||||
|
||||
Unless you're on a home/private LAN, you should [enable TLS access](https://docs.docker.com/articles/https/).
|
||||
31
docs/misc/related-projects.md
Normal file
31
docs/misc/related-projects.md
Normal file
@@ -0,0 +1,31 @@
|
||||
### [itzg/minecraft-bedrock-server](https://github.com/itzg/docker-minecraft-bedrock-server)
|
||||
|
||||
Docker image that runs a Minecraft Bedrock server.
|
||||
|
||||
### [mc-router](https://github.com/itzg/mc-router)
|
||||
|
||||
Lightweight multiplexer/proxy for Minecraft Java servers. Provided as a stand-alone application and a Docker image.
|
||||
|
||||
### [itzg/bungeecord](https://github.com/itzg/docker-bungeecord/)
|
||||
|
||||
Docker image that runs a proxy powered by Bungeecord, Velocity, or Waterfall
|
||||
|
||||
### [itzg/mc-backup](https://github.com/itzg/docker-mc-backup)
|
||||
|
||||
Docker image that runs as a side-car container to backup world data.
|
||||
|
||||
### [rcon-cli](https://github.com/itzg/rcon-cli)
|
||||
|
||||
A tool that is bundled with this image to provide CLI access to an RCON endpoint.
|
||||
|
||||
### [mc-monitor](https://github.com/itzg/mc-monitor)
|
||||
|
||||
A tool that is bundled with this image that provides health checks and metrics reporting, such as a Prometheus exporter or a telegraf data source.
|
||||
|
||||
### [mc-image-helper](https://github.com/itzg/mc-image-helper)
|
||||
|
||||
A tool that is bundled with this image to provide complex, re-usable preparation operations.
|
||||
|
||||
### [itzg/rcon](https://github.com/itzg/docker-rcon-web-admin)
|
||||
|
||||
An image that dockerizes [rcon-web-admin](https://github.com/rcon-web-admin/rcon-web-admin).
|
||||
Reference in New Issue
Block a user