From 16263bb7b36eb79c7f18eaa51e24ef4fb63db37d Mon Sep 17 00:00:00 2001 From: shortwavesurfer2009 <116814522+shortwavesurfer2009@users.noreply.github.com> Date: Fri, 19 Jul 2024 19:07:31 -0400 Subject: [PATCH] Update deployment documentation (#1152) --- docs/deployment-guide.md | 44 +++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md index 3a814dd883..92b2894408 100644 --- a/docs/deployment-guide.md +++ b/docs/deployment-guide.md @@ -24,7 +24,38 @@ Some good hints about how to secure a VPS are in [Monero's meta repository](http ## Fork and build Haveno -First fork Haveno to a public repository. Then build Haveno: +### Install dependencies + +On Linux and macOS, install Java JDK 21: + +`curl -s "https://get.sdkman.io" | bash` +`sdk install java 21.0.2.fx-librca` + +On Windows, install MSYS2 and Java JDK 21: + +Install MSYS2. + +Start MSYS2 MINGW64 or MSYS MINGW32 depending on your system. Use MSYS2 for all commands throughout this document. + +Update pacman: `pacman -Syy` + +Install dependencies. During installation, use default=all by leaving the input blank and pressing enter. + +64-bit: `pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake git` + +32-bit: `pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake git` + +`curl -s "https://get.sdkman.io" | bash` + +`sdk install java 21.0.2.fx-librca` + +### Alternative Instructions + +#### Ubuntu 22.04 + +`sudo apt-get install openjdk-21-jdk` + +Fork Haveno to a public repository. Then build Haveno: ``` git clone @@ -57,9 +88,12 @@ For each seed node: 1. [Build the Haveno repository](#fork-and-build-haveno). 2. [Start a local Monero node](#start-a-local-monero-node). -3. Run `make seednode` to run a seednode on Monero's mainnet or `make seednode-stagenet` to run a seednode on Monero's stagenet. -4. The node will print its onion address to the console. Record the onion address in `core/src/main/resources/xmr_.seednodes`. Be careful to record full addresses correctly. -5. Update all seed nodes, arbitrators, and user applications for the change to take effect. +3. Modify `./scripts/deployment/haveno-seednode.service` and `./scripts/deployment/haveno-seednode2.service` as needed. +4. Copy `./scripts/deployment/haveno-seednode.service` to `/etc/systemd/system` (if you are the very first seed in a new network also copy `./scripts/deployment/haveno-seednode2.service` to `/etc/systemd/system`). +5. Run `sudo systemctl start haveno-seednode.service` to start the seednode and also run `sudo systemctl start haveno-seednode2.service` if you are the very first seed in a new network and coppied haveno-seednode2.service to your systemd folder. +6. Run `journalctl -u haveno-seednode.service -b -f` which will print the log and show the `.onion` address of the seed node. Press `Ctrl+C` to stop printing the log and record the `.onion` address given. +7. Add the `.onion` address to `core/src/main/resources/xmr_.seednodes` along with the port specified in the haveno-seednode.service file(s) `(ex: example.onion:1002)`. Be careful to record full addresses correctly. +8. Update all seed nodes, arbitrators, and user applications for the change to take effect. Customize and deploy haveno-seednode.service to run a seed node as a system service. @@ -222,4 +256,4 @@ Arbitrators can manually sign payment accounts. First open the legacy UI. ## Other tips * If a dispute does not open properly, try manually reopening the dispute with a keyboard shortcut: `ctrl + o`. -* To send a private notification to a peer: click the user icon and enter `alt + r`. Enter a private key which is registered to send private notifications. \ No newline at end of file +* To send a private notification to a peer: click the user icon and enter `alt + r`. Enter a private key which is registered to send private notifications.