From 23ada3cc1a9071ff4847bf7776e1f2141ef70b1d Mon Sep 17 00:00:00 2001 From: Levi Date: Mon, 19 Feb 2024 01:29:03 +0100 Subject: [PATCH] Update .example.env documentation --- .example.env | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/.example.env b/.example.env index ea9dc87..89c93a5 100644 --- a/.example.env +++ b/.example.env @@ -57,6 +57,7 @@ WEB_WORKERS=5 ## Bancho configuration +# These are the ports, that older clients will connect to BANCHO_TCP_PORTS=[13380, 13381, 13382, 13383] # You can change this, depending on how many threads you have @@ -71,7 +72,7 @@ AUTOJOIN_CHANNELS=['#osu', '#announce'] # Used for bancho_connect.php endpoint (optional) # Make sure this ip is not proxied in any way -PUBLIC_BANCHO_IP= +PUBLIC_BANCHO_IP=127.0.0.1 # This will verify the hash of the client, if set to False # You will need to edit the manifest.json file on the website @@ -80,6 +81,7 @@ DISABLE_CLIENT_VERIFICATION=True ## Website configuration +# You can change this, depending on how many threads you have FRONTEND_WORKERS=4 # Set this to something unique @@ -88,18 +90,18 @@ FRONTEND_SECRET_KEY=somethingrandom # Enable this if you are using an ssl certificate ENABLE_SSL=False -## Nginx configuration +# This is used for in-game links and the reverse-proxy +# Example: `lekuru.xyz`, `example.com`, `localhost` +DOMAIN_NAME=localhost NGINX_HOST=0.0.0.0 NGINX_PORT=80 -DOMAIN_NAME=localhost - -## Discord configuration +## Discord configuration (optional) ENBALE_DISCORD_BOT=False DISCORD_BOT_PREFIX=! DISCORD_BOT_TOKEN= # Used for importing beatmaps (optional) -OSU_API_KEY= \ No newline at end of file +OSU_API_KEY=