Skip to content

Commit

Permalink
docs: add install on docker
Browse files Browse the repository at this point in the history
  • Loading branch information
ShrBox committed Jan 20, 2025
1 parent 0c1cbd5 commit 957d40b
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/main/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nav:
- Player Guides:
- Install:
- player_guides/install.md
- Install on Docker: https://github.com/LiteLDev/levilamina-docker-server
- player_guides/install_on_docker.md
- player_guides/troubleshooting.md

- Developer Guides:
Expand Down
29 changes: 29 additions & 0 deletions docs/main/player_guides/install_on_docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Install on Docker

## Installation

To start the server in a Linux container, run the following command:

```sh
docker run -d -it -e EULA=TRUE -p 19132:19132/udp -v levilamina-server-data:/data ghcr.io/liteldev/levilamina-server:latest-wine
```

Or, if you want to use a Windows container, run the following command:

```sh
docker run -d -it -e EULA=TRUE -p 19132:19132/udp -v levilamina-server-data:C:\data ghcr.io/liteldev/levilamina-server:latest-windows
```

We also provide Docker Compose files for both Linux and Windows containers at [wine/compose.yaml](wine/compose.yaml) and [windows/compose.yaml](windows/compose.yaml) respectively. To use them, download the file to an empty directory and run `docker compose up -d`.

### Environment variables

- `EULA`: must be set to `TRUE` to accept the [Minecraft End User License Agreement](https://minecraft.net/terms).

- `GITHUB_MIRROR_URL`: can be set to a GitHub mirror URL to speed up the installation of LeviLamina. This is useful when you are behind a firewall or in a country with slow internet connection.

- `GO_MODULE_PROXY_URL`: can be set to a Go module proxy URL to speed up the installation of LeviLamina. This is useful when you are behind a firewall or in a country with slow internet connection.

- `PACKAGES`: can be set to a list of packages to install on first run. Each package must be a valid [lip specifier](https://docs.lippkg.com/commands/lip_install.html). Both local and remote lip teeth are supported. For local packages, you may need to mount the packages to the container.

- `VERSION` (`LATEST`): can be set to a specific [LeviLamina](https://github.com/LiteLDev/LeviLamina/tags) version or `LATEST` to automatically download the latest version.
36 changes: 36 additions & 0 deletions docs/main/player_guides/install_on_docker.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 在Docker上安装

## 安装

要在 Linux 容器中启动服务器,请运行第一条命令;如果您的服务器在中国大陆,请运行第二条命令以更快快速地安装:

```sh
docker run -d -it -e EULA=TRUE -p 19132:19132/udp -v levilamina-server-data:/data ghcr.io/liteldev/levilamina-server:latest-wine
```
```sh
docker run -d -it -e EULA=TRUE -e GITHUB_MIRROR_URL=https://github.bibk.top -e GO_MODULE_PROXY_URL=https://goproxy.cn -p 19132:19132/udp -v levilamina-server-data:/data ghcr.nju.edu.cn/liteldev/levilamina-server:latest-wine
```

或者,如果您想使用 Windows 容器,请运行第一条命令;如果您的服务器在中国大陆,请运行第二条命令以更快快速地安装:

```sh
docker run -d -it -e EULA=TRUE -p 19132:19132/udp -v levilamina-server-data:C:\data ghcr.io/liteldev/levilamina-server:latest-windows
```
```sh
docker run -d -it -e EULA=TRUE -e GITHUB_MIRROR_URL=https://github.bibk.top -e GO_MODULE_PROXY_URL=https://goproxy.cn -p 19132:19132/udp -v levilamina-server-data:C:\data ghcr.nju.edu.cn/liteldev/levilamina-server:latest-windows
```

我们还提供了适用于 Linux 和 Windows 容器的 Docker Compose 文件,分别位于 [wine/compose.yaml](wine/compose.yaml)[windows/compose.yaml](windows/compose.yaml)
要使用它们,请将文件下载到一个空目录并运行 `docker compose up -d`

### 环境变量

- `EULA`: 必须设置为 `TRUE` 以接受 [Minecraft 最终用户许可协议](https://minecraft.net/terms)

- `GITHUB_MIRROR_URL`: 可以设置为 GitHub 镜像 URL,以加快 LeviLamina 的安装速度。这在您处于防火墙后面或在网络连接较慢的国家时非常有用。

- `GO_MODULE_PROXY_URL`: 可以设置为 Go 模块代理 URL,以加快 LeviLamina 的安装速度。这在您处于防火墙后面或在网络连接较慢的国家时非常有用。

- `PACKAGES`: 可以设置为首次运行时要安装的软件包列表。每个软件包必须是有效的 [lip 规范](https://docs.lippkg.com/commands/lip_install.html)。支持本地和远程 lip 包。对于本地软件包,您可能需要将软件包挂载到容器中。

- `VERSION` (`LATEST`): 可以设置为特定的 [LeviLamina](https://github.com/LiteLDev/LeviLamina/tags) 版本或 `LATEST` 以自动下载最新版本。

0 comments on commit 957d40b

Please sign in to comment.