Skip to content

Explorer, API, and Soroban options

This guide documents additional service-level options available in:

  • docker-explorer.conf
  • docker-nginx.conf
  • docker-soroban.conf
  • docker-node.conf

All commands are to be copy and pasted into the terminal of your Dojo, then press ENTER.

Open explorer config:

Terminal window
cd ~/dojo-app/docker/my-dojo/conf/
nano docker-explorer.conf

To use BTC-RPC Explorer:

Terminal window
EXPLORER_INSTALL=on
EXPLORER_TYPE=btc_rpc_explorer

To use mempool.space:

Terminal window
EXPLORER_INSTALL=on
EXPLORER_TYPE=mempool_space

Then apply changes:

Terminal window
cd ~/dojo-app/docker/my-dojo
./dojo.sh upgrade

Note for mempool_space: current Dojo integration expects an Electrum endpoint reachable by INDEXER_IP:INDEXER_RPC_PORT over TCP.

When using mempool_space, these options are used by mempool’s own database:

Terminal window
MEMPOOL_MYSQL_USER=mempool
MEMPOOL_MYSQL_PASS=mempool
MEMPOOL_MYSQL_ROOT_PASSWORD=admin
MEMPOOL_MYSQL_DATABASE=mempool

Set these before first install. Do not modify them on an already running installation.

To disable the explorer entirely, set:

Terminal window
EXPLORER_INSTALL=off

Then apply changes:

Terminal window
cd ~/dojo-app/docker/my-dojo
./dojo.sh upgrade

This option applies only when:

Terminal window
EXPLORER_TYPE=btc_rpc_explorer

Use slower/lower-resource mode:

Terminal window
EXPLORER_SLOW_DEVICE_MODE=on

Use faster mode on stronger hardware:

Terminal window
EXPLORER_SLOW_DEVICE_MODE=off

Then apply changes:

Terminal window
cd ~/dojo-app/docker/my-dojo
./dojo.sh upgrade

By default, Dojo API stays inside Docker and Tor.

To expose nginx (Dojo API) to trusted local devices, open:

Terminal window
cd ~/dojo-app/docker/my-dojo/conf/
nano docker-nginx.conf

Set:

Terminal window
NGINX_EXTERNAL=on
NGINX_EXTERNAL_IP=127.0.0.1
NGINX_EXTERNAL_PORT=3000

For macOS or Windows Docker hosts, set NGINX_EXTERNAL_IP to the Docker VM IP instead of 127.0.0.1.

Then apply changes:

Terminal window
cd ~/dojo-app/docker/my-dojo
./dojo.sh upgrade

Warning: do not expose this port to the public internet.

Open Soroban config:

Terminal window
cd ~/dojo-app/docker/my-dojo/conf/
nano docker-soroban.conf

Disable Soroban completely:

Terminal window
SOROBAN_INSTALL=off

Keep Soroban installed but do not announce its RPC endpoint publicly:

Terminal window
SOROBAN_INSTALL=on
SOROBAN_ANNOUNCE=off

Then apply changes:

Terminal window
cd ~/dojo-app/docker/my-dojo
./dojo.sh upgrade

Open node config:

Terminal window
cd ~/dojo-app/docker/my-dojo/conf/
nano docker-node.conf

Disable outgoing PandoTx pushes:

Terminal window
NODE_PANDOTX_PUSH=off

Disable processing incoming PandoTx transactions:

Terminal window
NODE_PANDOTX_PROCESS=off

NODE_PANDOTX_PROCESS is effective only if SOROBAN_INSTALL=on and SOROBAN_ANNOUNCE=on.

Choose fallback mode for push behavior:

Terminal window
NODE_PANDOTX_FALLBACK_MODE=secure

or:

Terminal window
NODE_PANDOTX_FALLBACK_MODE=convenient

Set retries for failed pushes:

Terminal window
NODE_PANDOTX_NB_RETRIES=2

Then apply changes:

Terminal window
cd ~/dojo-app/docker/my-dojo
./dojo.sh upgrade