fulcrum docs update

This commit is contained in:
openoms
2023-03-20 18:34:11 +00:00
parent c6fb6c2579
commit 19f357d090

View File

@@ -6,21 +6,18 @@
- [Do I need to stop Electrs?](#do-i-need-to-stop-electrs) - [Do I need to stop Electrs?](#do-i-need-to-stop-electrs)
- [Database corrupted](#database-corrupted) - [Database corrupted](#database-corrupted)
- [Automated setup](#automated-setup) - [Automated setup](#automated-setup)
- [Manual setup](#manual-setup) - [Display the Tor address](#display-the-tor-address)
- [Prepare bitcoind](#prepare-bitcoind) - [Restart](#restart)
- [Prepare the system and directories](#prepare-the-system-and-directories) - [Edit the config](#edit-the-config)
- [Create a config file](#create-a-config-file) - [Create a config file](#create-a-config-file)
- [Create a systemd service](#create-a-systemd-service) - [Create a systemd service](#create-a-systemd-service)
- [Start](#start) - [Start](#start)
- [Monitor](#monitor) - [Monitor](#monitor)
- [Open the firewall](#open-the-firewall)
- [Set up SSL](#set-up-ssl) - [Set up SSL](#set-up-ssl)
- [Create a Tor .onion service](#create-a-tor-onion-service) - [Create a Tor .onion service](#create-a-tor-onion-service)
- [Remove the Fulcrum user and installation (not the database)](#remove-the-fulcrum-user-and-installation-not-the-database) - [Remove the Fulcrum user and installation (not the database)](#remove-the-fulcrum-user-and-installation-not-the-database)
- [Docker setup](#docker-setup) - [Docker setup](#docker-setup)
- [Generate TLS credentials](#generate-tls-credentials) - [Generate TLS credentials](#generate-tls-credentials)
- [Start the image](#start-the-image)
- [Docker compose snippet](#docker-compose-snippet)
- [Sources:](#sources) - [Sources:](#sources)
This is a rough overview, the guide is a work in progress. This is a rough overview, the guide is a work in progress.
@@ -65,10 +62,31 @@ cat bonus.fulcrum.sh
# run with debug # run with debug
bash -x bonus.fulcrum.sh on bash -x bonus.fulcrum.sh on
``` ```
* if running RaspiBlitz v1.7.2 the script is part of the image: * if running RaspiBlitz v1.7.2 and above the script is part of the image:
``` ```
config.scripts/bonus.fulcrum.sh on config.scripts/bonus.fulcrum.sh on
``` ```
### Display the Tor address
* ```
sudo cat /mnt/hdd/tor/fulcrum/hostname
```
### Connect
* TCP port 50021
* SSL 50022
* the IP address is your Raspiblitz IP
* consider using Zerotier or Tailscale for remote connection though clearnet
### Monitor
* ```
sudo journalctl -fu fulcrum
```
### Restart
sudo systemctl restart fulcrum
### Edit the config
* ```
sudo nano /home/fulcrum/.fulcrum/fulcrum.conf
```
## Manual setup ## Manual setup
@@ -98,7 +116,7 @@ sudo tail -n 100 -f /mnt/hdd/bitcoin/debug.log | grep txindex
### Prepare the system and directories ### Prepare the system and directories
``` * ```
# Create a dedicated user # Create a dedicated user
sudo adduser --disabled-password --gecos "" fulcrum sudo adduser --disabled-password --gecos "" fulcrum
cd /home/fulcrum cd /home/fulcrum
@@ -212,13 +230,13 @@ sudo systemctl start fulcrum
``` ```
### Monitor ### Monitor
``` * ```
sudo journalctl -fu fulcrum sudo journalctl -fu fulcrum
sudo systemctl status fulcrum sudo systemctl status fulcrum
``` ```
### Open the firewall ### Open the firewall
``` * ```
sudo ufw allow 50021 comment 'Fulcrum TCP' sudo ufw allow 50021 comment 'Fulcrum TCP'
sudo ufw allow 50022 comment 'Fulcrum SSL' sudo ufw allow 50022 comment 'Fulcrum SSL'
``` ```
@@ -374,12 +392,12 @@ ssl = 0.0.0.0:50027
``` ```
### Generate TLS credentials ### Generate TLS credentials
``` * ```
openssl req -newkey rsa:2048 -sha256 -nodes -x509 -days 3650 -subj "/O=Fulcrum" -keyout "tls.key" -out "tls.cert" openssl req -newkey rsa:2048 -sha256 -nodes -x509 -days 3650 -subj "/O=Fulcrum" -keyout "tls.key" -out "tls.cert"
``` ```
### Start the image ### Start the image
adapt the values as needed * adapt the values as needed
``` ```
docker image pull cculianu/fulcrum:latest docker image pull cculianu/fulcrum:latest
docker run \ docker run \
@@ -397,7 +415,7 @@ docker run \
Fulcrum /fulcrum.conf Fulcrum /fulcrum.conf
``` ```
### Docker compose snippet ### Docker compose snippet
``` * ```
fulcrum: fulcrum:
image: cculianu/fulcrum:latest image: cculianu/fulcrum:latest
depends_on: [bitcoind] depends_on: [bitcoind]