From e34d3f918683cbc9f3d8324cdbffd89a5a8eef9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20W=C5=82odarek?= Date: Wed, 31 Oct 2018 17:45:57 +0100 Subject: [PATCH] Add monero-wallet-gui reference --- .../monero-wallet-gui-reference.md | 64 +++++++++++++++++++ docs/interacting/monerod-reference.md | 2 +- docs/todo/p2p.md | 1 + mkdocs.yml | 1 + 4 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 docs/interacting/monero-wallet-gui-reference.md create mode 100644 docs/todo/p2p.md diff --git a/docs/interacting/monero-wallet-gui-reference.md b/docs/interacting/monero-wallet-gui-reference.md new file mode 100644 index 0000000..f799827 --- /dev/null +++ b/docs/interacting/monero-wallet-gui-reference.md @@ -0,0 +1,64 @@ +--- +title: monero-wallet-gui - Reference | Monero Documentation +--- +# `monero-wallet-gui` - Reference + +## Overview + +### Desktop GUI wallet + +The "official" desktop wallet for Monero. Available for Linux, macOS and Windows. + +Wallet uses your private keys to understand your total balance, +transactions history, and to facilitate creating transactions. + +However, wallet does not store the blockchain and does not directly participate in the p2p network. + +### Depends on the full node + +Wallet connects to [full node](/interacting/monerod-reference) to scan the blockchain for your transaction outputs and to send your transactions out to the network. + +The full node can be either local (same computer) or remote. + +Normally, you run the full node on the same computer as wallet (or within your home network). + +Connection happens over HTTP and uses [this API](https://www.getmonero.org/resources/developer-guides/wallet-rpc.html). + +Any transaction leaving the wallet is already blinded by all Monero privacy features. +This means plain text HTTP communication isn't an issue on its own even if you connect to a remote node. + +However, connecting to a remote node has other nuanced trade-offs, which is a topic for a separate article. TODO: write an article or link the best available source. + +### User guide PDF + +A nice PDF guide is available in the catalog you unpacked Monero. Make sure to check it out! + +The online living version is also available:
+[https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/monero-GUI-guide.md](https://github.com/monero-ecosystem/monero-GUI-guide/blob/master/monero-GUI-guide.md) + +## Syntax + +`./monero-wallet-gui [options]` + +Example: + +`./monero-wallet-gui --log-file=/dev/null` + +## Running + +Go to directory where you unpacked Monero. + +Run the full node and wait until it syncs up with the network (may take up to a few days): + +`./monerod` + +In a separate terminal window, run the wallet: + +`./monero-wallet-gui` + +## Options + +| Option | Description +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------- +| `--help` | Enlists available options. +| `--log-file` | Full path to the log file. Example (mind file permissions):
`./monerod --log-file=/var/log/monero/mainnet/monerod.log` diff --git a/docs/interacting/monerod-reference.md b/docs/interacting/monerod-reference.md index 1308449..c349184 100644 --- a/docs/interacting/monerod-reference.md +++ b/docs/interacting/monerod-reference.md @@ -32,7 +32,7 @@ Options define how the daemon should be working. Their names follow the `--optio Commands give access to specific services provided by the daemon. Commands are executed against the running daemon. Their names follow the `command_name` pattern. -### Running +## Running Go to directory where you unpacked Monero. diff --git a/docs/todo/p2p.md b/docs/todo/p2p.md new file mode 100644 index 0000000..39ad8e9 --- /dev/null +++ b/docs/todo/p2p.md @@ -0,0 +1 @@ +https://monero.stackexchange.com/questions/1/how-do-the-monero-nodes-find-each-other diff --git a/mkdocs.yml b/mkdocs.yml index 185fab4..a80aa5b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,6 +12,7 @@ nav: - Overview: 'interacting/overview.md' - Config: 'interacting/monero-config-file.md' - monerod: 'interacting/monerod-reference.md' + - monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md' - Technical specs: 'technical-specs.md' - Cryptography: - Introduction: 'cryptography/introduction.md'