Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c-d-lewis/docker-minecraft
Standalone Docker-based Minecraft server setup with backups and DNS record management
https://github.com/c-d-lewis/docker-minecraft
Last synced: 2 days ago
JSON representation
Standalone Docker-based Minecraft server setup with backups and DNS record management
- Host: GitHub
- URL: https://github.com/c-d-lewis/docker-minecraft
- Owner: C-D-Lewis
- Created: 2024-09-11T20:00:49.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-12T19:47:28.000Z (4 days ago)
- Last Synced: 2024-11-12T20:31:20.543Z (4 days ago)
- Language: Shell
- Homepage:
- Size: 70.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-minecraft
Standalone Docker-based Minecraft server setup with backups and DNS record
management, primarily for Raspberry Pi 5 with 4+ GB of RAM.
* [Prerequisites](#prerequisites)
* [Customizations](#customizations)
* [Docker build and run](#docker-build-and-run)
* [Stopping the server](#stopping-the-server)
* [Backups](#backups)
* [DNS](#dns)
## Prerequisites
1. Install this repo to a fast SSD located at `/mnt/ssd`.
2. Install [Docker](https://docs.docker.com/engine/install/debian/) for aarch64.
Optionally, for supporting scripts:
3. Install AWS CLI v2.
4. Install node 20 with `nvm`.
## Customizations
For each configured server, the files unique to it are stored in a directory
in `./config`. This allows the project to build and run multiple servers from
the same set of scripts.
Change the server icon, Message of The Day, and more in the `server.properties`
file.
Change the amount of memory allocated in `config.json` to be no more than
75% available on the system.
## Docker build and run
> Once running, all files changed in the container except the mounted `/world*`
> and `config/$SERVER_NAME/plugins` directories will be lost when the container
> exits. Use `docker exec -t -i $CONTAINER_ID /bin/bash` to explore and copy
> needed files out.
Choose a set of configuration files from `./config` to use when building and
running the server image. For example:
```shell
./scripts/start-docker.sh test
```
Add to crontab to run on boot with `sudo crontab -e`, assuming a location of
`/mnt/ssd/`. Make sure the desired server config is included, such as `test`:
```
@reboot sleep 15 && cd /mnt/ssd/docker-minecraft && ./scripts/start-docker.sh test
```
Logs will be stored in `docker-minecraft.log`.
## Stopping the server
To safely stop the server, log in as an Op user and run the `/stop` command.
If not possible, force-stop the container:
```
docker ps
```
With the container ID:
```
docker stop $CONTAINER_ID
```
## Backups
### Local
Backup manually and copy somewhere safe:
```shell
sudo ./scripts/local-backup.sh $SERVER_NAME $USER
```
Add the `local-backup.sh` script to crontab to run once a day and copy a file
for each day of the week (7 day rolling backups), for example at 3 AM:
```
0 3 * * * cd /mnt/ssd/docker-minecraft && ./scripts/local-backup.sh test pi > /home/pi/local-backup.log 2>&1
```
### S3 Remote
> Requires the AWS CLI.
Upload a backup to an AWS S3 bucket that you have credentials to use:
```shell
sudo ./scripts/upload-backup.sh $SERVER_NAME $USER
```
Add to crontab for weekly backups (4AM Monday) with your AWS credentials:
```
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
0 4 * * 1 cd /mnt/ssd/docker-minecraft && ./scripts/upload-backup.sh test pi > /home/pi/upload-backup.log 2>&1
```
## DNS
Use the `scripts/update-dns.sh` script to keep a DNS record pointed at the
server's public IP address in case it changes.
Install Node.js via `nvm`:
```shell
# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
# Install node 20
nvm install 20
nvm alias default 20
```
Install node dependencies:
```
npm i
```
Run the monitor with AWS credentials that can update Route53 records, server
config to use:
```shell
export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
./scripts/update-dns.sh $SERVER_NAME
```
Add to crontab to run the monitor on boot:
```
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
@reboot sleep 15 && cd /mnt/ssd/docker-minecraft && ./scripts/update-dns.sh test > /home/pi/update-dns.log 2>&1
```