How to run pricenode - Revision history

Strayorigin at 16:51, 5 May 2025

2025-05-05T16:51:07Z

Strayorigin at 16:42, 5 May 2025

2025-05-05T16:42:47Z

Strayorigin at 16:40, 5 May 2025

2025-05-05T16:40:16Z

Strayorigin at 16:38, 5 May 2025

2025-05-05T16:38:21Z

Strayorigin at 16:36, 5 May 2025

2025-05-05T16:36:44Z

Strayorigin at 16:35, 5 May 2025

2025-05-05T16:35:15Z

Strayorigin at 16:33, 5 May 2025

2025-05-05T16:33:51Z

Strayorigin: /* Prerequisites */

2025-05-05T16:32:31Z

Prerequisites

Strayorigin at 16:31, 5 May 2025

2025-05-05T16:31:15Z

Strayorigin at 16:28, 5 May 2025

2025-05-05T16:28:17Z

@@ Line 12: / Line 12: @@
 == Overview ==
-The pricenode software runs a simple HTTP service, typically listening on <code>localhost:8080</code>, with key endpoints including:
+The pricenode software runs a simple HTTP service, typically listening on `localhost:8080`, with key endpoints including:
 * `<code>/getAllMarketPrices</code>`: Returns current BTC exchange rates against various fiat currencies and altcoins.
 * `<code>/getFees</code>`: Returns current estimates for Bitcoin transaction fees (in satoshis/vByte) for different confirmation targets.
@@ Line 22: / Line 22: @@
 * '''Operating System:''' Linux (Debian/Ubuntu preferred, as automated scripts are available).
 * '''Java:''' A compatible Java Runtime Environment (JRE) is needed to run the application. (Check the GitHub repository for current version requirements).
-* '''[[Tor]]:''' The `tor` binary must be installed and operational for running as a hidden service.
+* '''Tor:''' The `tor` binary must be installed and operational for running as a hidden service.
 * '''System Resources:''' While not extremely resource-intensive, reliable uptime, sufficient RAM (e.g., 1GB+), disk space (~10GB), and network bandwidth (~1TB/month might be a starting point) are needed. Official requirements may be specified on the [[Pricenode Operator]] role page.
@@ Line 33: / Line 33: @@
 # Ensure `curl` and `sudo` are available: `sudo apt update && sudo apt install curl`
 # Run the installer script:
-  curl -s https://raw.githubusercontent.com/bisq-network/bisq-pricenode/main/scripts/install_pricenode_debian.sh | sudo bash
+  curl -s <nowiki>https://raw.githubusercontent.com/bisq-network/bisq-pricenode/main/scripts/install_pricenode_debian.sh</nowiki> | sudo bash
 # Follow any prompts from the script.
 # **Important:** At the end of the script, it should output your node's unique **Tor `.onion` address**. Record this address carefully, especially if you plan to use the node yourself or apply to become a default operator. You will also need to [[Backing_up_application_data#Export_Tor_state|back up the hidden service's private key]] (`/var/lib/tor/hidden_service/private_key` or similar, depending on Tor setup).
@@ Line 41: / Line 41: @@
 # Install Git and a compatible JDK. (Check the GitHub repository for current version requirements).
 # Clone the repository (including submodules):
-  git clone --recursive https://github.com/bisq-network/bisq-pricenode.git
+  git clone --recursive <nowiki>https://github.com/bisq-network/bisq-pricenode.git</nowiki>
   cd bisq-pricenode
 # Build the application using Gradle:
@@ Line 49: / Line 49: @@
 == Running and Managing ==
-If you used the installation script (Method 1), the pricenode should be running as a `systemd` service named `bisq-pricenode`. You can manage it with standard Linux `systemd` commands, for example:
+If you used the installation script (Method 1), the pricenode should be running as a `systemd` service named `bisq-pricenode`. You can manage it with standard commands:
 * Check Status: `<code>sudo systemctl status bisq-pricenode</code>`
 * Stop Service: `<code>sudo systemctl stop bisq-pricenode</code>`
@@ Line 76: / Line 75: @@
 == Becoming a Default Operator ==
 Running a pricenode doesn't automatically make it used by other Bisq clients. To become one of the default nodes hardcoded in the Bisq software, you generally need to:
-Apply for the [[Pricenode Operator]] role.
+Contact current maintainers or check the `#pricenode` channel on Matrix/Discord for details on the current application process.
 == Monitoring ==
-Operators whose nodes are included in the default list within Bisq releases are required to set up monitoring using collectd and provide network size data. This involves running additional setup scripts found in the GitHub repository's README ([https://www.google.com/search?q=https://github.com/bisq-network/bisq-pricenode%23monitoring see Monitoring section]) and coordinating with the Bisq monitoring team.
+Operators whose nodes are included in the default list within Bisq releases are required to set up monitoring using `collectd` and provide network size data. This involves running additional setup scripts found in the GitHub repository's README ([https://github.com/bisq-network/bisq-pricenode#monitoring see Monitoring section]) and coordinating with the Bisq monitoring team.
 == Compensation ==
 Approved [[Pricenode Operator|Pricenode Operators]] who maintain reliable nodes included in the default list can request compensation from the Bisq DAO for their service and hosting costs.
 [[Category:Guides]]
 [[Category:Infrastructure]]

@@ Line 33: / Line 33: @@
 # Ensure `curl` and `sudo` are available: `sudo apt update && sudo apt install curl`
 # Run the installer script:
-<syntaxhighlight lang="bash">
+ curl -s https://raw.githubusercontent.com/bisq-network/bisq-pricenode/main/scripts/install_pricenode_debian.sh | sudo bash
 # Follow any prompts from the script.
 # **Important:** At the end of the script, it should output your node's unique **Tor `.onion` address**. Record this address carefully, especially if you plan to use the node yourself or apply to become a default operator. You will also need to [[Backing_up_application_data#Export_Tor_state|back up the hidden service's private key]] (`/var/lib/tor/hidden_service/private_key` or similar, depending on Tor setup).
@@ Line 43: / Line 41: @@
 # Install Git and a compatible JDK. (Check the GitHub repository for current version requirements).
 # Clone the repository (including submodules):
-<syntaxhighlight lang="bash">
+ git clone --recursive https://github.com/bisq-network/bisq-pricenode.git
-git clone --recursive https://github.com/bisq-network/bisq-pricenode.git
+ cd bisq-pricenode
 # Build the application using Gradle:
-<syntaxhighlight lang="bash">
+ ./gradlew clean build
 # Manually configure [[Tor]] to create a hidden service that points to the pricenode's listening port (default 8080). Consult the official Tor documentation for setting up onion services.
 # Determine how to run the built Java application persistently (e.g., using `screen`, `tmux`, or creating your own `systemd` service).

@@ Line 70: / Line 70: @@
 * '''Locally (if installed via script):'''
 Check if the node is responding on the default local port:
-  curl http://localhost:8080/getAllMarketPrices
+  curl <nowiki>http://localhost:8080/getAllMarketPrices</nowiki>
-  curl http://localhost:8080/getFees
+  curl <nowiki>http://localhost:8080/getFees</nowiki>
 * '''Over Tor (replace with your node's address):'''
 Use `torsocks` (or configure Tor as a system proxy) to query your node's `.onion` address (replace `YOUR_ONION_ADDRESS.onion` with the actual address):
-  torsocks curl http://YOUR_ONION_ADDRESS.onion/getAllMarketPrices
+  torsocks curl <nowiki>http://YOUR_ONION_ADDRESS.onion/getAllMarketPrices</nowiki>
-  torsocks curl http://YOUR_ONION_ADDRESS.onion/getFees
+  torsocks curl <nowiki>http://YOUR_ONION_ADDRESS.onion/getFees</nowiki>
 Successful queries should return JSON formatted data containing price and fee information.

@@ Line 70: / Line 70: @@
 * '''Locally (if installed via script):'''
 Check if the node is responding on the default local port:
-<syntaxhighlight lang="bash">
+ curl http://localhost:8080/getAllMarketPrices
-curl http://localhost:8080/getAllMarketPrices
+ curl http://localhost:8080/getFees
 * '''Over Tor (replace with your node's address):'''
 Use `torsocks` (or configure Tor as a system proxy) to query your node's `.onion` address (replace `YOUR_ONION_ADDRESS.onion` with the actual address):
-<syntaxhighlight lang="bash">
+ torsocks curl http://YOUR_ONION_ADDRESS.onion/getAllMarketPrices
-torsocks curl http://YOUR_ONION_ADDRESS.onion/getAllMarketPrices
+ torsocks curl http://YOUR_ONION_ADDRESS.onion/getFees
 Successful queries should return JSON formatted data containing price and fee information.

@@ Line 66: / Line 66: @@
 == Testing ==
-You can test if your node is running correctly by querying its endpoints.
+You can test if your node is running correctly by querying its endpoints using `curl` or a similar tool.
-Locally (if installed via script):
+* '''Locally (if installed via script):'''
-&lt;syntaxhighlight lang="bash">
+Check if the node is responding on the default local port:
 curl http://localhost:8080/getAllMarketPrices
 curl http://localhost:8080/getFees
-&lt;/syntaxhighlight>
+</syntaxhighlight>
 == Becoming a Default Operator ==
 Running a pricenode doesn't automatically make it used by other Bisq clients. To become one of the default nodes hardcoded in the Bisq software, you generally need to:

@@ Line 55: / Line 55: @@
 == Running and Managing ==
-If you used the installation script (Method 1), the pricenode should be running as a systemd service named bisq-pricenode. You can manage it with standard commands:
+If you used the installation script (Method 1), the pricenode should be running as a `systemd` service named `bisq-pricenode`. You can manage it with standard Linux `systemd` commands, for example:
-Check Status: sudo systemctl status bisq-pricenode
+* Check Status: `<code>sudo systemctl status bisq-pricenode</code>`
-Stop: sudo systemctl stop bisq-pricenode
+* Stop Service: `<code>sudo systemctl stop bisq-pricenode</code>`
-Start: sudo systemctl start bisq-pricenode
+* Start Service: `<code>sudo systemctl start bisq-pricenode</code>`
-Restart: sudo systemctl restart bisq-pricenode
+* Restart Service: `<code>sudo systemctl restart bisq-pricenode</code>`
-View Logs: journalctl -u bisq-pricenode -f
+* View Logs (live): `<code>journalctl -u bisq-pricenode -f</code>`
 If you built from source (Method 2), you are responsible for starting, stopping, and managing the Java process.
 == Testing ==

@@ Line 20: / Line 20: @@
 Running a pricenode requires a stable environment, typically a server or VPS:
-Operating System: Linux (Debian/Ubuntu preferred, as automated scripts are available).
+* '''Operating System:''' Linux (Debian/Ubuntu preferred, as automated scripts are available).
-Java: A compatible Java Runtime Environment (JRE) is needed to run the application. (Check the GitHub repository for current version requirements).
+* '''Java:''' A compatible Java Runtime Environment (JRE) is needed to run the application. (Check the GitHub repository for current version requirements).
-Tor: The tor binary must be installed and operational for running as a hidden service.
+* '''[[Tor]]:''' The `tor` binary must be installed and operational for running as a hidden service.
-System Resources: While not extremely resource-intensive, reliable uptime, sufficient RAM (e.g., 1GB+), disk space (~10GB), and network bandwidth (~1TB/month might be a starting point) are needed. Official requirements may be specified on the [[Pricenode Operator]] role page.
+* '''System Resources:''' While not extremely resource-intensive, reliable uptime, sufficient RAM (e.g., 1GB+), disk space (~10GB), and network bandwidth (~1TB/month might be a starting point) are needed. Official requirements may be specified on the [[Pricenode Operator]] role page.
 == Setup and Installation ==

@@ Line 9: / Line 9: @@
 The primary source for the pricenode software and technical details is the [https://github.com/bisq-network/bisq-pricenode official GitHub repository]. This guide summarizes the key steps based on that repository.
-TOC
+__TOC__
 == Overview ==