Skip to content
Open sourceDeveloper environmentEnvironment variables

OctoBot’s environment variables

Tentacles installation

TENTACLES_URL_TAG overrides the default OctoBot version tag for tentacles package installation. Some additional tags are available :

  • latest : to install the latest published tentacles (usually requires an up-to-date dev branch on OctoBot to work)
  • tests/XXX : for tentacles_manager package tests

Node interface

  • NODE_PORT (Docker and docker-compose): host port mapped to the node UI inside the container (default 8000). The node listens on port 8000 inside the image unless you change the container configuration.
  • When running OctoBot locally without Docker, open http://localhost:8000/ after start unless your install documentation says otherwise.

Manual OctoBot web interface

These variables apply to each manual OctoBot child web UI (not the node UI on 8000):

  • WEB_ADDRESS overrides the host IP address, can be set to 0.0.0.0 to accept all incoming connections.
  • WEB_PORT overrides the default web port (5001).
  • PORT is also used in some deployments as an alias for the manual web port; prefer WEB_PORT when both are documented for your setup.
  • CHILD_WEB_PORTS (Docker): port range forwarded for manual OctoBots started from the node (default 5001-5010).

Exchanges

  • DEFAULT_REQUEST_TIMEOUT: Exchanges requests timeout in milliseconds. Can be increased if your internet connection is very slow. Default value is 20000.
  • ENABLE_CCXT_VERBOSE: Set to True to log each ccxt exchange request. Default is False.
  • ENABLE_CCXT_RATE_LIMIT: Set to False to disable ccxt rate limit. This will make each exchange request to be instantly emitted. Be careful as this can lead to an IP ban if the exchange spamming rules are not respected. Default is True.