Skip to content

Commit

Permalink
add notes for the extra image
Browse files Browse the repository at this point in the history
  • Loading branch information
Fallen-Breath committed Mar 17, 2024
1 parent a6bf65c commit 3b9b9d4
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ 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
- `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
- This mounting 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
Expand Down Expand Up @@ -74,6 +74,15 @@ mcdreforged/mcdreforged-extra:2.13.0-py3.11
mcdreforged/mcdreforged-extra:2.13.0-py3.11-slim
```

> [!NOTE]
> To ensure the feasibility of python package installation during extra image build,
> the actual installed version of those python package in the extra images might not be exactly what the plugin wants
> [!TIP]
> For production environment, it's suggested to maintain your own set of python package installation instead of simply use the extra images,
> by manually installing what your plugins need and mounting the `site-packages` directory inside the container to a persist storage,
> to ensure that the all of your plugins run within the python package environment they claim to be compatible with.
### OpenJDK

Images with OpenJDK installed
Expand Down

0 comments on commit 3b9b9d4

Please sign in to comment.