Skip to content

Commit 7b262ee

Browse files
committed
Document
1 parent b4ff458 commit 7b262ee

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction and Automatic Setup
2-
Do you want to run a server for Create: Astral without the hassle of setting up Java and Fabric?
3-
This repository allow you to run a server for the Create: Astral Minecraft® modpack using a container engine like `podman` or `docker`.
2+
Do you want to run a server for [Create: Astral](https://www.curseforge.com/minecraft/modpacks/create-astral) without the hassle of setting up Java and Fabric?
3+
This repository allow you to run a server for the Create: Astral Minecraft® modpack using a container engine like [`podman`](https://podman.io/) or [`docker`](https://www.docker.com/).
44
Everything is bundled, just do some configuration and you're set.
55

66
To set up:
@@ -39,7 +39,7 @@ If you want to modify other files like those in the `config` folder, consider ad
3939
`/data/config` folder as a volume similar to how the files above are set up.
4040

4141
# Manual Setup
42-
The server can be set up without using a layer like `podman-compose` or `docker-compose`.
42+
The server can be set up without using a program like `podman-compose` or `docker-compose`.
4343

4444
Simply run (The commands should be mostly equivalent for `docker`)
4545
```bash
@@ -57,6 +57,12 @@ podman run -d -e EULA=TRUE \
5757
```
5858
to get started. This will run a Create: Astral server on port 25565 (the default) which stores the game world in a named volume.
5959

60+
# Maintenance
61+
See the documentation for your preferred container engine for comprehensive guidance. Some hints:
62+
- You can set up automatic restart using `restart: always` in `compose.yml` or the `--restart=always` flag when not using compose.
63+
- Use `podman/docker logs [-f] <container name>` to inspect server logs. Adding `-f/--follow` causes log output to be displayed continously.
64+
- Look into backing up the `world` volume.
65+
6066
# Contributing
6167
Feel free to send a merge request for any improvements you'd like.
6268

0 commit comments

Comments
 (0)