Difference between revisions of "Data directory"

From Bisq Wiki
Jump to navigation Jump to search
(add note about backing up data directory)
(Cleanup: Correct headings, add version context, improve links, add categories.)
Line 1: Line 1:
The '''data directory''' is where all of Bisq's data files are stored.
+
The '''data directory''' is where all of Bisq's application data files (including wallet, account details, trade history, and settings) are stored locally on your computer.
  
It is crucial that you [[Backing_up_application_data|back up this directory]] regularly.
+
It is crucial that you [[Backing_up_application_data|back up this directory]] regularly to prevent data loss.
 +
 
 +
{{Admonition_Note|'''Version Context:''' The directory structure described below is primarily based on Bisq v1. The location and general purpose remain similar in [[Bisq 2]], although specific file organization within subdirectories like `db/` or `keys/` might differ due to features like multiple [[Identity|identities]].}}
  
 
__TOC__
 
__TOC__
  
= Data directory structure =
+
== Data directory structure ==
 +
 
 +
Notable items typically found within the main Bisq data directory:
  
Notable items in the data directory:
+
* `bisq.log` - The main log file containing recent application activity, often helpful for debugging. Be cautious sharing it publicly as it may contain private information.
 +
* `bisq.properties` - A configuration file where the full list of [https://github.com/bisq-network/bisq/blob/master/common/src/main/java/bisq/common/config/Config.java#L57 command-line options] can be permanently set (one per line in `<option>=<value>` format, e.g., `dumpStatistics=true`), avoiding the need to specify them each time Bisq is launched.
 +
* `btc_mainnet/` - The primary subdirectory containing most network-specific operational data.
 +
** `keys/` - Stores cryptographic keys used for signing P2P network messages and for [[Account_limits|signing and aging]] payment accounts (in Bisq v1).
 +
** `db/` - Contains various user data (e.g., closed trades, DAO state) and network data. '''It is strongly discouraged to manually edit any files in this directory.'''
 +
** `tor/` - Holds state data for the built-in [[Tor]] connection. The `hiddenservice/` folder within this directory contains the keys determining your Bisq [[Changing_your_onion_address|onion address]].
 +
** `wallet/` - Contains your BTC and [[BSQ]] wallet files (`bisq_BTC.wallet`, `bisq_BSQ.wallet`), rolling backups, and the SPV chain file (`[[Resyncing SPV file|bisq.spvchain]]`).
  
* <code>bisq.log</code> - main log file with most recent logs, often helpful for debugging. This file may contain private information, so it's usually not wise to post the whole thing publicly.
+
== Default locations ==
* <code>bisq.properties</code> - place to store [https://github.com/bisq-network/bisq/blob/master/common/src/main/java/bisq/common/config/Config.java#L57 command-line options], so you don't have to specify them every time you run Bisq (where each option is on a new line in <code><option>=<value></code> format, e.g., <code>dumpStatistics=true</code>).
 
* <code>btc_mainnet/</code> - main data directory.
 
** <code>keys/</code> - keys for signing P2P messages as well as signing and aging payment accounts.
 
** <code>db/</code> - various user data and network data. It is strongly discouraged to edit any files in this directory.
 
** <code>tor/</code> - Tor state data. The <code>hiddenservice/</code> folder within determines your onion address.
 
** <code>wallet/</code> - BTC and BSQ wallet files and rolling backups, as well as the <code>bisq.spvchain</code> file.
 
  
= Default locations =
+
The default location of the main Bisq data directory varies by operating system.
  
 
{{Default_data_directory_locations}}
 
{{Default_data_directory_locations}}
 +
== See also ==
  
= See also =
+
* [[Backing_up_application_data|Backing up application data]]
 
+
* [[Restoring application data]]
 
* [[Switching to a new data directory]]
 
* [[Switching to a new data directory]]
 
* [[Running from the command line]]
 
* [[Running from the command line]]
 +
 +
[[Category:Configuration]]
 +
[[Category:Technical]]
 +
[[Category:Troubleshooting]]

Revision as of 18:23, 1 May 2025

The data directory is where all of Bisq's application data files (including wallet, account details, trade history, and settings) are stored locally on your computer.

It is crucial that you back up this directory regularly to prevent data loss.

Note
Version Context: The directory structure described below is primarily based on Bisq v1. The location and general purpose remain similar in Bisq 2, although specific file organization within subdirectories like `db/` or `keys/` might differ due to features like multiple identities.

Data directory structure

Notable items typically found within the main Bisq data directory:

  • `bisq.log` - The main log file containing recent application activity, often helpful for debugging. Be cautious sharing it publicly as it may contain private information.
  • `bisq.properties` - A configuration file where the full list of command-line options can be permanently set (one per line in `<option>=<value>` format, e.g., `dumpStatistics=true`), avoiding the need to specify them each time Bisq is launched.
  • `btc_mainnet/` - The primary subdirectory containing most network-specific operational data.
    • `keys/` - Stores cryptographic keys used for signing P2P network messages and for signing and aging payment accounts (in Bisq v1).
    • `db/` - Contains various user data (e.g., closed trades, DAO state) and network data. It is strongly discouraged to manually edit any files in this directory.
    • `tor/` - Holds state data for the built-in Tor connection. The `hiddenservice/` folder within this directory contains the keys determining your Bisq onion address.
    • `wallet/` - Contains your BTC and BSQ wallet files (`bisq_BTC.wallet`, `bisq_BSQ.wallet`), rolling backups, and the SPV chain file (`bisq.spvchain`).

Default locations

The default location of the main Bisq data directory varies by operating system.

Windows

Using PowerShell:

$home\AppData\Roaming\Bisq\

Using cmd:

%USERPROFILE%\AppData\Roaming\Bisq\

macOS

/Users/<username>/Library/Application Support/Bisq/

This folder could be hidden and not normally accessible on Macs, check the documentation by Apple to see how to be able to work with it.

Linux

/home/<username>/.local/share/Bisq/

See also