How to Configure Initially - dapucita/haxbotron GitHub Wiki

Language : English, Korean(한국어)


How to Configure Initially

You can configure some initial settings for core server.

You don't have to build(compile) again after configure, so it is very convenient.

Tweaks settings in previous versions are also integrated into this way.

How to set

First create .env file into the directory where core server is located.

After create the file, open and edit by text editor and save it.

You don't have to build(compile) again after configure, but you need to restart your bot application for reflect some changes.

Refer to .env.sample file if you feels difficult to set up.

Cautions

Do not share .env file with other people.

Especially it is recommended to be careful not to leak it out if important information is contained.

If the bot makes some errors after configure .env file, you'd better to check again the correct format.


Control server access

Port Number

You can manually set the port number of the core server by setting SERVER_PORT. (default 12001)

SERVER_PORT = 12001

_If the core server is 127.0.0.1 and you set the port number as 12345, you can use Web-based Management System by connect to 127.0.0.1:12345.

IP Address Whitelist

You can set SERVER_WHITELIST_IP to specify the IP addresses to allow access to the core server.

SERVER_WHITELIST_IP = "::ffff:127.0.0.1,127.0.0.1"

The IP addresses are separated by comma (,). The clients not on this list cannot access the core server.


Configure management system

JWT Secret Key

You can set up JWT_SECRET to replace the JWT secret key used for account authentication logic.

JWT_SECRET = "key here"

Do not share this key with other people.


Connect with servers

DB Server Connection

You can connect to the db server by setting up SERVER_CONN_DB_HOST, SERVER_CONN_DB_PORT, SERVER_CONN_DB_APIVER.

Set SERVER_CONN_DB_HOST to specify the IP address of the remote location where the db server is located.

Set SERVER_CONN_DB_PORT to specify the port number of the db server located at a remote location.

Set SERVER_CONN_DB_APIVER to specify the version of the API to use.

SERVER_CONN_DB_HOST = "127.0.0.1"
SERVER_CONN_DB_PORT = "13000"
SERVER_CONN_DB_APIVER = "v1"

If you set like these, you will be connected to the db server located at 127.0.0.1:13000.


Tweaks for solve problems

You can set some tweaks options to fix various problems with the bot.

Headless Mode

If you want to open the browser as non-headless mode, disable this option.

In environments such as servers where the GUI is not supported, disabling this option might prevent the server from running properly.

Set as 'false' for disable this option.

TWEAKS_HEADLESSMODE = false

Local IP WebRTC Anonymization

If you are suffering connection problem with vps server, disable this option.

Set as false for disable this option.

TWEAKS_WEBRTCANOYM = false

Overriding GeoLocation

If your game room was displayed with wrong location, enable this option and set as your correct location.

Set as true for enable this option, and change CODE(country), LAT(latitude), LON(longitude) as your location.

TWEAKS_GEOLOCATIONOVERRIDE = true
TWEAKS_GEOLOCATIONOVERRIDE_CODE = "KR"
TWEAKS_GEOLOCATIONOVERRIDE_LAT = 37.5665
TWEAKS_GEOLOCATIONOVERRIDE_LON = 126.978