From d8624be9fe9294dd4dfe53a80726c5f9d9125ab1 Mon Sep 17 00:00:00 2001 From: ilguappo Date: Sat, 2 Aug 2025 23:20:36 -0700 Subject: [PATCH] update: readme update for holesail v2 --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 734406b..86851d5 100644 --- a/README.md +++ b/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 @@ -108,7 +108,7 @@ services: 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. @@ -131,7 +131,7 @@ services: ROLE: user USERNAME: admin PASSWORD: admin - CONNECTOR: very-super-secret + KEY: very-super-secret volumes: - :/data ``` @@ -153,7 +153,7 @@ services: PORT: 25565 HOST: minecraft PUBLIC: false - CONNECTOR: very-super-secret + KEY: very-super-secret networks: - holesail