1  #
  2  #_____________________________________________________|_._._._._._._._._,
  3  #\____________________________________________________|_|_|_|_|_|_|_|_|_|
  4  #                                                     !
  5  # RoninDojo user defined configuration file ~/.config/RoninDojo/user.conf
  6  #_____________________________________________________|_._._._._._._._._,
  7  #\____________________________________________________|_|_|_|_|_|_|_|_|_|
  8  #                                                     !
  9  #
 10  # Copy file to $HOME/.config/RoninDojo/user.conf then edit variables before
 11  # an installation of RoninDojo or a Dojo upgrade.
 12  # NOTE: Mysql user and password settings only apply during initial installation.
 13  #
 14  
 15  #                                                                                               #
 16  # DO NOT EDIT THIS FILE DIRECTLY AS THIS FILE IS COPIED TO YOUR ~/.config/RoninDojo DIRECTORY   #
 17  #                                                                                               #
 18  
 19  ##############################
 20  # Repo branch overrides      #
 21  ##############################
 22  # Note you must use full reference path if you plan on testing a different branch
 23  # other than master. i.e origin/branch_name instead of just branch_name
 24  
 25  #ronin_dojo_branch="origin/master" # defaults to origin/master
 26  #samourai_commitish=""      # empty defaults to master
 27  
 28  ##############################
 29  # Filesystem paths           #
 30  ##############################
 31  
 32  # Install directory variable can ONLY be enabled once during initial install. DO NOT EDIT this is
 33  # on an existing RoninDojo installation!
 34  #install_dir=""
 35  
 36  #
 37  # Ronin UI
 38  #
 39  
 40  # ronin_ui_path must be set before installation of backend UI service
 41  
 42  #ronin_ui_path=""
 43  
 44  # These values are for the desktop GUI app
 45  #gui_api=""
 46  
 47  # Default swap overrides create_swap creation. Set only in user.conf
 48  # swapfile_size=2096 # Use only 2G of swap
 49  
 50  #########################
 51  # Dojo Indexer Override #
 52  #########################
 53  #dojo_indexer=""
 54  
 55  # Default is set to "fulcrum".
 56  # Value: addrindexrs | fulcrum | electrs
 57  
 58  ##############################
 59  # Samourai Dojo Credentials  #
 60  ##############################
 61  
 62  #
 63  # NOTE: Make sure your passwords/keys are at least 12 characters long and contain letters, numbers, and special characters.
 64  # by default RoninDojo will generate a secure and random password/key for you. see ~/RoninDojo/Scripts/generated-credentials.sh for info
 65  #
 66  
 67  ##############################
 68  # Bitcoin Daemon             #
 69  ##############################
 70  
 71  # User account used for rpc access to bitcoind
 72  # Type: alphanumeric
 73  #BITCOIND_RPC_USER=""
 74  
 75  # Password of user account used for rpc access to bitcoind
 76  # Type: alphanumeric
 77  #BITCOIND_RPC_PASSWORD=""
 78  
 79  # Max number of connections to network peers
 80  # Type: integer
 81  #BITCOIND_MAX_CONNECTIONS=16
 82  
 83  # Mempool maximum size in MB
 84  # Type: integer
 85  #BITCOIND_MAX_MEMPOOL=1024
 86  
 87  # Db cache size in MB
 88  # Type: integer
 89  #BITCOIND_DB_CACHE="1024"
 90  
 91  # bitcoind db cache optimization.
 92  #bitcoind_db_cache_total=0.6 # Uses 60% of total RAM
 93  
 94  # EXPOSE BITCOIND RPC API AND ZMQ NOTIFICATIONS TO EXTERNAL APPS
 95  # THESE PARAMETERS HAVE NO EFFECT IF BITCOIND_INSTALL IS SET TO OFF
 96  #
 97  # Expose the RPC API to external apps
 98  # Warning: Do not expose your RPC API to internet!
 99  # See BITCOIND_RPC_EXTERNAL_IP
100  # Value: on | off
101  #BITCOIND_RPC_EXTERNAL=on
102  
103  # IP address used to expose the RPC API to external apps
104  # This parameter is inactive if BITCOIND_RPC_EXTERNAL isn't set to 'on'
105  # Warning: Do not expose your RPC API to internet!
106  # Recommended value:
107  #   linux: 127.0.0.1
108  #   macos or windows: IP address of the VM running the docker host
109  # Type: string
110  #BITCOIND_RPC_EXTERNAL_IP=127.0.0.1
111  
112  #
113  # SHUTDOWN
114  #
115  # Max delay for bitcoind shutdown (expressed in seconds)
116  # Defines how long Dojo waits for a clean shutdown of bitcoind before shutting down the bitcoind container
117  # This parameter is inactive if BITCOIND_INSTALL is set to 'off'
118  # Type: integer
119  #BITCOIND_SHUTDOWN_DELAY=180
120  
121  ##############################
122  # Node.js                    #
123  ##############################
124  
125  # API key required for accessing the services provided by the server
126  # Keep this API key secret!
127  # Provide a value with a high entropy!
128  # Type: alphanumeric
129  #NODE_API_KEY=""
130  
131  # API key required for accessing the admin/maintenance services provided by the server
132  # Keep this Admin key secret!
133  # Provide a value with a high entropy!
134  # Type: alphanumeric
135  #NODE_ADMIN_KEY=""
136  
137  # Indexer or third-party service used for imports and rescans of addresses
138  # Values: local_bitcoind | third_party_explorer
139  #NODE_ACTIVE_INDEXER=local_bitcoind
140  
141  ##############################
142  # MySQL                      #
143  ##############################
144  # WARNING: these values can ONLY be enabled once and only before a Dojo install
145  
146  #MYSQL_ROOT_PASSWORD=""
147  #MYSQL_USER=""
148  #MYSQL_PASSWORD=""
149  
150  ##############################
151  # Bitcoin Explorer           #
152  ##############################
153  
154  # Install and run a block explorer inside Dojo (recommended)
155  # Value: on | off
156  #EXPLORER_INSTALL=on
157  
158  # Password required for accessing the block explorer
159  # (login can be anything)
160  # Keep this password secret!
161  # Provide a value with a high entropy!
162  # Type: alphanumeric
163  #EXPLORER_KEY=""
164  
165  ##############################
166  # Mempool Space Visualizer   #
167  ##############################
168  
169  #MEMPOOL_MYSQL_USER=""
170  #MEMPOOL_MYSQL_PASSWORD=""
171  
172  #
173  # Custom variable not working? We currently only support variables in the ~/RoninDojo/user.conf.example file.
174  #