Home

NxBot Wiki

NxBot requires Nx Witness as well as Telegram. The following sections will serve to aide in setting up these services to work with NxBot.

Config Variables

There are a handful of config/environment variables required to run NxBot. Here you'll find the necessary information to obtain the appropriate values to get up and running.

NxBot can be configured to run using environment variables (recommended under Docker deployment), or by writing a config.yml, located in the same directory as the nxbot.exe (or no .exe for non-Windows) binary.

Example: config.yml

• NX_IP_PORT (env) / nx_ip_port (yaml)

  Format: <IP>:<PORT e.g. 192.168.1.2:7001

  Your Nx server's local IP address. The standard port is 7001.

• NX_USER (env) / nx_user (yaml)

  The username of the Nx account. This can be a dedicated account with appropriate access or the account you already use to access Nx.

• NX_PASS (env) / nx_pass (yaml)

  The password for the above Nx account.