Skip to content

Commit

Permalink
Update .example.env documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Lekuruu authored Feb 19, 2024
1 parent c1d08ff commit 23ada3c
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions .example.env
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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=
OSU_API_KEY=

0 comments on commit 23ada3c

Please sign in to comment.