ilguappo/holesail-docker
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

update: readme update for holesail v2
All checks were successful
Docker Image CI / docker (push) Successful in 1m35s
Details

Browse Source
This commit is contained in:
ilguappo
2025-08-02 23:20:36 -07:00
parent 0478070458
commit d8624be9fe
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -17,7 +17,7 @@ The following environment variables are available:
- HOST: The hostname or IP address to use for the client or server mode. - HOST: The hostname or IP address to use for the client or server mode.
- PUBLIC: A boolean value indicating whether the server should use a public connetor string. Only applicable in server mode. - PUBLIC: A boolean value indicating whether the server should use a public connetor string. Only applicable in server mode.
- FORCE: A boolean value indicating whether to force a short connector string of less than 32 chars. Only applicable in server and filemanager modes. - FORCE: A boolean value indicating whether to force a short connector string of less than 32 chars. Only applicable in server and filemanager modes.
- CONNECTOR: A connector string used to identify the connection. Can be used in client, server, and filemanager modes. - KEY: A string used to identify the connection. Can be used in client, server, and filemanager modes.
- USERNAME: The username to use for authentication in filemanager mode. - USERNAME: The username to use for authentication in filemanager mode.
- PASSWORD: The password to use for authentication in filemanager mode. - PASSWORD: The password to use for authentication in filemanager mode.
- ROLE: The role to assign to the user in filemanager mode. Can be either admin or user. - ROLE: The role to assign to the user in filemanager mode. Can be either admin or user.
@@ -41,7 +41,7 @@ docker run -d --name holesail \
-e MODE=server \ -e MODE=server \
-e PORT=25565 \ -e PORT=25565 \
-e HOST=minecraft \ -e HOST=minecraft \
-e CONNECTOR=very-super-secret \ -e KEY=very-super-secret \
-e PUBLIC=false \ -e PUBLIC=false \
--network holesail \ --network holesail \
anaxios/holesail:latest anaxios/holesail:latest
@@ -66,7 +66,7 @@ services:
PORT: 25565 PORT: 25565
HOST: minecraft HOST: minecraft
PUBLIC: false PUBLIC: false
CONNECTOR: very-super-secret KEY: very-super-secret
networks: networks:
- holesail - holesail
@@ -108,7 +108,7 @@ services:
PORT: 8989 PORT: 8989
HOST: 0.0.0.0 HOST: 0.0.0.0
PUBLIC: false PUBLIC: false
CONNECTOR: very-super-secret KEY: very-super-secret
``` ```
**Note:** Client mode only works on Linux, and is incompatible with Windows and Mac. **Note:** Client mode only works on Linux, and is incompatible with Windows and Mac.
@@ -131,7 +131,7 @@ services:
ROLE: user ROLE: user
USERNAME: admin USERNAME: admin
PASSWORD: admin PASSWORD: admin
CONNECTOR: very-super-secret KEY: very-super-secret
volumes: volumes:
- <host dir>:/data - <host dir>:/data
``` ```
@@ -153,7 +153,7 @@ services:
PORT: 25565 PORT: 25565
HOST: minecraft HOST: minecraft
PUBLIC: false PUBLIC: false
CONNECTOR: very-super-secret KEY: very-super-secret
networks: networks:
- holesail - holesail