Update deployment documentation (#1152)

This commit is contained in:
shortwavesurfer2009 2024-07-19 19:07:31 -04:00 committed by GitHub
parent 326cfdfb80
commit 16263bb7b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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 <your fork url>
@ -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_<network>.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_<network>.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.
* 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.