-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #82: Add MEMO.md, update README.md accordingly
029002a Add DEMO.md, update README.md accordingly (Daniela Brozzoni) Pull request description: Needs revault/revaultd#153 Closes #74 ACKs for top commit: edouardparis: ACK 029002a Tree-SHA512: e2d277e929c585eee4dfc303a8ba5a1cf64d6605a2da990289a4307ac21db5d488b5784bffa5c6f6c31aa1655475d16c0e41fda734cd4ae67b99a2a41c0a8049
- Loading branch information
Showing
2 changed files
with
71 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Tutorial: using revault-gui for the first time! | ||
|
||
## Prerequisites | ||
### Having revaultd, cosignerd and coordinatord up and running | ||
Check out the [revaultd tutorial](https://github.com/revault/revaultd/tree/master/doc/DEMO.md)! | ||
### Libraries | ||
The following libraries are needed: | ||
- `libvulkan-dev` | ||
- `cmake` | ||
- `pkg-config` | ||
|
||
The installation method varies depending on the OS. | ||
|
||
## Let's get started! | ||
|
||
Go back to your `revault_tutorial` directory and clone the GUI: | ||
``` | ||
git clone -b 0.1 https://github.com/revault/revault-gui | ||
``` | ||
|
||
You working directory should look like: | ||
``` | ||
. | ||
├── coordinatord | ||
├── cosignerd | ||
├── revaultd | ||
├── revault-gui | ||
``` | ||
|
||
Starting the GUI should be quite straightforward if the daemon is running correctly. Let's make sure that the daemon is not dead: | ||
``` | ||
cd revaultd | ||
stake_1_cli getinfo | ||
``` | ||
If you get an error, go back to the [revaultd tutorial](https://github.com/revault/revaultd/tree/master/doc/DEMO.md). Otherwise, let's start! | ||
``` | ||
cd ../revault-gui | ||
``` | ||
|
||
Building the GUI... | ||
``` | ||
cargo build --release | ||
``` | ||
|
||
### 1. Providing the configuration | ||
Let's create some aliases: | ||
``` | ||
alias stake_1_gui="REVAULTD_CONF=\"../revaultd/stake_1_config.toml\" cargo run --release" | ||
alias stake_2_gui="REVAULTD_CONF=\"../revaultd/stake_2_config.toml\" cargo run --release" | ||
alias man_1_gui="REVAULTD_CONF=\"../revaultd/man_1_config.toml\" cargo run --release" | ||
``` | ||
|
||
### 2. Let the GUI start the binary (optional) | ||
If you don't want to start `revaultd` manually each time you run the config, you can set the `REVAULTD_PATH` environment variable. | ||
This will start `revaultd` **only**, you'll need to start yourself `coordinatord` and `cosignerd` anyways. | ||
Double check that the `revaultd` configuration has `daemon=true`, otherwise the gui won't be able to start. | ||
Then: | ||
``` | ||
export REVAULTD_PATH="../revaultd/target/debug/revaultd" | ||
``` | ||
|
||
### 3. Starting the GUI | ||
|
||
``` | ||
stake_1_gui | ||
stake_2_gui | ||
man_1_gui | ||
``` | ||
|
||
Et voilá! |