RallyBlock/Blockland-Docker-Pelican
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Added Pelican Panel information
This commit is contained in:
RallyBlock
2026-03-07 19:44:43 -05:00
parent 1a54b60275
commit 679a9f38eb
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -6,11 +6,11 @@ Based on [eagle517](https://hub.docker.com/r/eagle517/blockland-server)'s origin
### How to use ### How to use
This image is designed to run **inside a Pelican Panel egg**. Running it manually (e.g., with `docker run` or `docker compose`) will likely not work correctly, since it expects Pelican's environment (e.g., `/home/container` as the working directory and Pelican-managed volume mounts). This image is designed to run **inside a Pelican Panel egg**. Running it manually (e.g., with `docker run` or `docker compose`) will likely not work correctly, since it expects Pelican's environment (e.g., `/home/container` as the working directory and Pelican-managed volume mounts).
Create a custom egg in Pelican that uses `rallyblockk/blockland-pelican` as its image, then configure the environment variables below. The container runs rootless (UID/GID 1000) by default—ensure your egg mounts volumes with appropriate permissions. Create a custom egg in Pelican that uses `rallyblockk/blockland-pelican` as its image (yolk), then add the environment variables below as egg variables. Pelican mounts the server data to `/home/container` automatically. The container runs as UID 1000—if you hit permission issues, check your node’s Wings configuration.
The image is available on Docker Hub at [rallyblockk/blockland-pelican](https://hub.docker.com/r/rallyblockk/blockland-pelican). The image is available on Docker Hub at [rallyblockk/blockland-pelican](https://hub.docker.com/r/rallyblockk/blockland-pelican).
**Note:** Blockland works best with host networking due to UDP and Join IP behavior (see Networking section). Configure your Pelican egg to use host network mode where supported. **Note:** Blockland works best with host networking due to UDP and Join IP behavior (see Networking section). Host network is configured in Wings (`/etc/pelican/config.yml`), not in the egg.
### Environment variables ### Environment variables
| Name | Type | Default | Description | | Name | Type | Default | Description |
@@ -34,10 +34,10 @@ The image is available on Docker Hub at [rallyblockk/blockland-pelican](https://
| WINEDEBUG | string | -all | Controls how much logging Wine does to the console (default hides everything) | WINEDEBUG | string | -all | Controls how much logging Wine does to the console (default hides everything)
### Networking ### Networking
Blockland uses UDP and can be finicky with Docker bridge networks. If your Pelican node supports it, configure the egg to use host network mode for the most reliable results. Host network is Linux-only. Blockland uses UDP and can be finicky with Docker bridge networks. For the most reliable results, configure Wings to use host network mode in `/etc/pelican/config.yml` (see [Pelican's optional config docs](https://pelican.dev/docs/wings/optional-config/)). Host network is Linux-only and removes Docker network isolation—use with caution on shared nodes.
### Volumes ### Volumes
Pelican mounts the server's data directory at `/home/container` (the working directory). The egg configuration in Pelican determines what gets persisted. The container runs as UID/GID 1000—Pelican typically handles permissions for mounted volumes, but if you run into permission issues, that may be the cause. Pelican mounts each server's data directory at `/home/container` (the working directory). Files there are persisted as the server's storage. The container runs as UID/GID 1000—Pelican typically handles permissions, but that can cause issues if something is misconfigured at the node level.
### Wine ### Wine
Wine seems to be having less and less compatibility with Blockland as time goes on. Back when Wine 5.18 came out, we lost the Curses backend, and it stopped being possible to interact with Blockland's console. I eventually figured out what the issue with Wine was, and created [Wine Fix](https://gitlab.com/Eagle517/wine-fix) which allowed console interaction to work with Wine up to 8.0.2. With Wine 9 and later, it appears the console is just completely broken now. I don't have the time to figure out what shenanigans the Wine devs got up to, so we're stuck with 8.0.2 for now. Wine seems to be having less and less compatibility with Blockland as time goes on. Back when Wine 5.18 came out, we lost the Curses backend, and it stopped being possible to interact with Blockland's console. I eventually figured out what the issue with Wine was, and created [Wine Fix](https://gitlab.com/Eagle517/wine-fix) which allowed console interaction to work with Wine up to 8.0.2. With Wine 9 and later, it appears the console is just completely broken now. I don't have the time to figure out what shenanigans the Wine devs got up to, so we're stuck with 8.0.2 for now.