Skip to content

Commit ae1bb12

Browse files
authored
Update README.md with instructions on how to specify the dockerfile inside of the compose.yaml directly & how to modify memory usage
1 parent a1cd675 commit ae1bb12

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ you run your compose command. The required templates for these files are include
3838
If you want to modify other files like those in the `config` folder, consider adding the
3939
`/data/config` folder as a volume similar to how the files above are set up.
4040

41+
## JVM Arguments (memory usage)
42+
43+
If you are building the image yourself, you can customize the JVM arguments used by the server in [`entrypoint.sh`](entrypoint.sh).
44+
4145
# Manual Setup
4246
The server can be set up without using a program like `podman-compose` or `docker-compose`.
4347

@@ -57,6 +61,15 @@ podman run -d -e EULA=TRUE \
5761
```
5862
to get started. This will run a Create: Astral server on port 25565 (the default) which stores the game world in a named volume.
5963

64+
## Building your own image
65+
66+
If you use compose, you can have the best of both worlds with very little modification. Replace the `image: ghcr.io/claraphyll/create-astral:v2.1.3` line in the [`compose.yaml`](compose.yaml) file with the following:
67+
```yaml
68+
build: .
69+
```
70+
71+
Now, when you run the command `podman-compose build` or `docker compose build` you will be able to build the image using the provided Dockerfile. This can allow you to modify your [`entrypoint.sh`](entrypoint.sh) or perform any other customizations, such as updating to an as of yet unsupported version of Create: Astral. Once it is built, you can run the container like normal using `docker compose up -d` or `podman-compose up -d`.
72+
6073
# Maintenance
6174
See the documentation for your preferred container engine for comprehensive guidance. Some hints:
6275
- You can set up automatic restart using `restart: always` in `compose.yml` or the `--restart=always` flag when not using compose.

0 commit comments

Comments
 (0)