Skip to content

Commit

Permalink
more readme thing
Browse files Browse the repository at this point in the history
  • Loading branch information
Fallen-Breath committed Dec 30, 2023
1 parent a81a6ce commit 82109cf
Showing 1 changed file with 41 additions and 13 deletions.
54 changes: 41 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,41 @@

Official docker images for [MCDReforged](https://github.com/Fallen-Breath/MCDReforged)

## Images
## Usages

### Quick start

Quick test if the docker and image works

Runtime environment:
- User: root
- Working directory: `/mcdr`
```bash
docker run -it --rm mcdreforged/mcdreforged
```

### Persist your server data

For a production usage, you need to persist the working directory: `/mcdr`,
where all MCDR related files and the server folder is in

```bash
docker run --name my_mcdr -v /path/to/my/server:/mcdr mcdreforged/mcdreforged
```

### Python package installation

If you want to installed custom python packages, you can:

1. Mount path `/root/.local/lib/python${PYTHON_VERSION}/site-packages/` to a volume or a local directory,
where `PYTHON_VERSION` is the major + minor version of the python interpreter, e.g. `3.11`
2. Use `pip3` to install packages you want
1. Mount path `/root/.local/lib/python${PYTHON_VERSION}/site-packages/` to a volume or a local directory
- `PYTHON_VERSION` is the major + minor version of the python interpreter, e.g. `3.11`
- This step is optional. Installing without the directory mounted results in the loss of the new packages when the container is removed
2. Use `pip3` to install whatever packages you want like usual. The `--user` argument is set automatically globally

```bash
$ docker exec -it my_mcdr pip3 install requests
```

## Images

### Base Image
### Base

[![Docker](https://img.shields.io/docker/v/mcdreforged/mcdreforged/latest)](https://hub.docker.com/r/mcdreforged/mcdreforged)

Expand All @@ -34,9 +56,11 @@ mcdreforged/mcdreforged:2.13.0-py3.11
mcdreforged/mcdreforged:2.13.0-py3.11-slim
```

### Image with extra packages
### Extra

Image with extra python packages

Extra packages are collected from the [Plugin Catalogue](https://github.com/MCDReforged/PluginCatalogue),
Theses extra packages are collected from the [Plugin Catalogue](https://github.com/MCDReforged/PluginCatalogue),
covering almost all required packages of the plugins in the catalogue

```bash
Expand All @@ -48,18 +72,22 @@ mcdreforged/mcdreforged-extra:2.13.0-py3.11
mcdreforged/mcdreforged-extra:2.13.0-py3.11-slim
```

### Image with OpenJDK
### OpenJDK

Supported openjdk distributions:
Images with OpenJDK installed

Supported OpenJDK distributions:

- [corretoo](https://aws.amazon.com/corretto/)
- [liberica](https://bell-sw.com/libericajdk/)
- [temurin](https://adoptium.net/temurin/)
- [zulu](https://www.azul.com/downloads/?package=jdk#zulu)

Supported java version: 8, 11, 17, 21

Default JDK version: 17

`-extra` suffix means with extra packages
`-extra` suffix means with [extra](#extra) packages

```bash
mcdreforged/mcdreforged-temurin:latest
Expand Down

0 comments on commit 82109cf

Please sign in to comment.