This commit is contained in:
17
README.md
17
README.md
@@ -17,7 +17,7 @@ The following environment variables are available:
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
@@ -41,7 +41,7 @@ docker run -d --name holesail \
|
||||
-e MODE=server \
|
||||
-e PORT=25565 \
|
||||
-e HOST=minecraft \
|
||||
-e CONNECTOR=very-super-secret \
|
||||
-e KEY=very-super-secret \
|
||||
-e PUBLIC=false \
|
||||
--network holesail \
|
||||
anaxios/holesail:latest
|
||||
@@ -66,7 +66,7 @@ services:
|
||||
PORT: 25565
|
||||
HOST: minecraft
|
||||
PUBLIC: false
|
||||
CONNECTOR: very-super-secret
|
||||
KEY: very-super-secret
|
||||
networks:
|
||||
- holesail
|
||||
|
||||
@@ -101,18 +101,17 @@ services:
|
||||
holesail:
|
||||
container_name: holesail
|
||||
restart: unless-stopped
|
||||
network_mode: "host"
|
||||
ports:
|
||||
- 8989:8989
|
||||
image: anaxios/holesail:latest
|
||||
environment:
|
||||
MODE: client
|
||||
PORT: 8989
|
||||
HOST: 0.0.0.0
|
||||
PUBLIC: false
|
||||
CONNECTOR: very-super-secret
|
||||
KEY: very-super-secret
|
||||
```
|
||||
|
||||
**Note:** Client mode only works on Linux, and is incompatible with Windows and Mac.
|
||||
|
||||
### Filemanager Mode
|
||||
|
||||
In Filemanager mode, Holesail-docker serves a file manager interface. Example `docker-compose.yml` file:
|
||||
@@ -131,7 +130,7 @@ services:
|
||||
ROLE: user
|
||||
USERNAME: admin
|
||||
PASSWORD: admin
|
||||
CONNECTOR: very-super-secret
|
||||
KEY: very-super-secret
|
||||
volumes:
|
||||
- <host dir>:/data
|
||||
```
|
||||
@@ -153,7 +152,7 @@ services:
|
||||
PORT: 25565
|
||||
HOST: minecraft
|
||||
PUBLIC: false
|
||||
CONNECTOR: very-super-secret
|
||||
KEY: very-super-secret
|
||||
networks:
|
||||
- holesail
|
||||
|
||||
|
Reference in New Issue
Block a user