user.conf.example

#
#_____________________________________________________|_._._._._._._._._,
#\____________________________________________________|_|_|_|_|_|_|_|_|_|
#                                                     !
# RoninDojo user defined configuration file ~/.config/RoninDojo/user.conf
#_____________________________________________________|_._._._._._._._._,
#\____________________________________________________|_|_|_|_|_|_|_|_|_|
#                                                     !
#
# Copy file to $HOME/.config/RoninDojo/user.conf then edit variables before
# an installation of RoninDojo or a Dojo upgrade.
# NOTE: Mysql user and password settings only apply during initial installation.
#

#                                                                                               #
# DO NOT EDIT THIS FILE DIRECTLY AS THIS FILE IS COPIED TO YOUR ~/.config/RoninDojo DIRECTORY   #
#                                                                                               #

#
# Uncomment below to define custom values.
#
# primary_storage & secondary_storage must point to a partition number i.e sda1
#
# Examples:
#         primary_storage="/dev/sda1"           # for SATA
#         primary_storage="/dev/nvme0n1p1"      # for NVMe
#         NODE_ADMIN_KEY="GLRZigyFihw+PAf1i"    # USE random passwords for the love of bitcoin
#

##############################
# Repo branch overrides      #
##############################
# Note you must use full reference path if you plan on testing a different branch
# other than master. i.e origin/branch_name instead of just branch_name

#ronin_dojo_branch="master" # defaults to master
#samourai_commitish=""      # empty defaults to master

##############################
# Filesystem paths           #
##############################

#primary_storage=""
#secondary_storage=""

# Install directory variable can ONLY be enabled once during initial install. DO NOT EDIT this is
# on an existing RoninDojo installation!
#install_dir=""

#
# Ronin UI
#

# ronin_ui_path must be set before installation of backend UI service

#ronin_ui_path=""

# These values are for the desktop GUI app
#gui_api=""

# Default swap overrides create_swap creation. Set only in user.conf
# swapfile_size=2096 # Use only 2G of swap

##############################
# Samourai Dojo Credentials  #
##############################

#
# NOTE: Make sure your passwords/keys are at least 12 characters long and contain letters, numbers, and special characters.
# by default RoninDojo will generate a secure and random password/key for you. see ~/RoninDojo/Scripts/generated-credentials.sh for info
#

##############################
# Bitcoin Daemon             #
##############################

# User account used for rpc access to bitcoind
# Type: alphanumeric
#BITCOIND_RPC_USER=""

# Password of user account used for rpc access to bitcoind
# Type: alphanumeric
#BITCOIND_RPC_PASSWORD=""

# Max number of connections to network peers
# Type: integer
#BITCOIND_MAX_CONNECTIONS=16

# Mempool maximum size in MB
# Type: integer
#BITCOIND_MAX_MEMPOOL=1024

# Db cache size in MB
# Type: integer
#BITCOIND_DB_CACHE="1024"

# bitcoind db cache optimization.
#bitcoind_db_cache_total=0.6 # Uses 60% of total RAM

# EXPOSE BITCOIND RPC API AND ZMQ NOTIFICATIONS TO EXTERNAL APPS
# THESE PARAMETERS HAVE NO EFFECT IF BITCOIND_INSTALL IS SET TO OFF
#
# Expose the RPC API to external apps
# Warning: Do not expose your RPC API to internet!
# See BITCOIND_RPC_EXTERNAL_IP
# Value: on | off
#BITCOIND_RPC_EXTERNAL=on

# IP address used to expose the RPC API to external apps
# This parameter is inactive if BITCOIND_RPC_EXTERNAL isn't set to 'on'
# Warning: Do not expose your RPC API to internet!
# Recommended value:
#   linux: 127.0.0.1
#   macos or windows: IP address of the VM running the docker host
# Type: string
#BITCOIND_RPC_EXTERNAL_IP=127.0.0.1

#
# SHUTDOWN
#
# Max delay for bitcoind shutdown (expressed in seconds)
# Defines how long Dojo waits for a clean shutdown of bitcoind before shutting down the bitcoind container
# This parameter is inactive if BITCOIND_INSTALL is set to 'off'
# Type: integer
#BITCOIND_SHUTDOWN_DELAY=180

##############################
# Node.js                    #
##############################

# API key required for accessing the services provided by the server
# Keep this API key secret!
# Provide a value with a high entropy!
# Type: alphanumeric
#NODE_API_KEY=""

# API key required for accessing the admin/maintenance services provided by the server
# Keep this Admin key secret!
# Provide a value with a high entropy!
# Type: alphanumeric
#NODE_ADMIN_KEY=""

# Indexer or third-party service used for imports and rescans of addresses
# Values: local_bitcoind | third_party_explorer
#NODE_ACTIVE_INDEXER=local_bitcoind

##############################
# MySQL                      #
##############################
# WARNING: these values can ONLY be enabled once and only before a Dojo install

#MYSQL_ROOT_PASSWORD=""
#MYSQL_USER=""
#MYSQL_PASSWORD=""

##############################
# Bitcoin Explorer           #
##############################

# Install and run a block explorer inside Dojo (recommended)
# Value: on | off
#EXPLORER_INSTALL=on

# Password required for accessing the block explorer
# (login can be anything)
# Keep this password secret!
# Provide a value with a high entropy!
# Type: alphanumeric
#EXPLORER_KEY=""

##############################
# Whirlpool                  #
##############################

# Install and run an instance of whirlpool-cli inside Docker
# Value: on | off
#WHIRLPOOL_INSTALL=on

# Resynchronize mix counters on startup (startup will be slower)
# Value: on | off
#WHIRLPOOL_RESYNC=on

#
# EXPERT SETTINGS
#

# Activate debug logs
# Value: on | off
#WHIRLPOOL_DEBUG=off

# Activate more debug logs
# Value: on | off
#WHIRLPOOL_DEBUG_CLIENT=off

##############################
# Mempool Space Visualizer   #
##############################

#MEMPOOL_MYSQL_USER=""
#MEMPOOL_MYSQL_PASSWORD=""

#
# Custom variable not working? We currently only support variables in the ~/RoninDojo/user.conf.example file.
#