Skip to content
This repository has been archived by the owner on Jun 15, 2021. It is now read-only.

Produce a 'getting started' guide #45

Merged
merged 23 commits into from May 28, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
378238b
Start getting-started document
May 3, 2018
a35bceb
Strip trailing whitespace (bisq-network/style#10)
cbeams May 2, 2018
0649f69
Add toc and section anchors
cbeams May 2, 2018
65005de
Explain advantage of storing bitcoin in Bisq wallet
May 3, 2018
72cabda
Refine "Configure national currency account" section, add screenshots
May 5, 2018
d832e82
Integrate @cbeams feedback + write last 2 sections
May 11, 2018
ed2dd1c
Fill body of 'take an offer' section
May 11, 2018
611d09b
Update sections 1 & 2 (screenshots & copy)
May 14, 2018
385a393
Update section 3 (title, screenshot, copy)
May 14, 2018
762aa99
Update section 4 (screenshots & copy)
May 15, 2018
467165b
Correct path for last screenshot
May 15, 2018
8fb4850
Add missing image (last screenshot)
May 15, 2018
70dc405
Replace "exchange" with "platform" to address @rex4539 feedback
May 16, 2018
d5fc8c9
Strip trailing whitespace (bisq-network/style#10)
cbeams May 16, 2018
8913f64
Edit latest draft
cbeams May 16, 2018
86ab2c2
Integrate changes from @cbeams' thorough review
May 18, 2018
9cfe385
Add new page for securing wallet, tweak wording
May 28, 2018
9f55ef1
Make seed words explanation clearer
May 28, 2018
831dcec
Favor inter-document xrefs vs link: syntax
cbeams May 28, 2018
4b3cc87
Refine seed word and backup admonitions
cbeams May 28, 2018
f74ae3d
Add 'improve this doc' section
cbeams May 28, 2018
aab1a7c
Refine 'next steps' section
cbeams May 28, 2018
fbf5cae
Change description for secure-wallet on index page
May 28, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions index.adoc
Expand Up @@ -3,6 +3,7 @@
* *_User Docs_*
** <<intro#, Introduction>> — What Bisq is, why it exists and how it works
** <<getting-started#, Getting Started>> — Go from zero to trading in 15 minutes
** <<secure-wallet#, Secure Your Wallet>> — Encrypt your wallet's data and write down its seed words

* *_Contributor Docs_*
** <<contributor-checklist#, New contributor checklist>>
Expand Down
29 changes: 19 additions & 10 deletions secure-wallet.adoc
Expand Up @@ -4,11 +4,11 @@
:imagesdir: images
:!figure-caption:

As with traditional money and valuables, it's critical that you take reasonable measures to keep your bitcoin safe. This short guide will explain how you can secure your Bisq wallet by (1) encrypting it and (2) saving its seed words so you can restore it later.
As with traditional money and valuables, it's critical that you take reasonable measures to keep your bitcoin safe. This short guide will explain how you can secure your Bisq wallet by (1) encrypting it and (2) writing down its seed words so you can restore it later.

== Encrypt your wallet

Before setting a password, your Bisq wallet files are stored on your hard drive unencrypted. That means anyone who gains access to your computer (whether by physically stealing it or hacking it remotely) can gain access to your private keys and take your bitcoin.
Before setting a password, your Bisq wallet files are stored on your hard drive unencrypted. That means anyone who gains access to your computer (whether by physically stealing it or by hacking it remotely) can gain access to your private keys and take your bitcoin.

Setting a password encrypts your Bisq wallet files so they're useless to anyone without the password.

Expand All @@ -17,17 +17,26 @@ To set a password, go to the `Wallet password` section of the `Account` screen a
.Set a password to encrypt your Bisq wallet.
image::set-password.png[Set a password to encrypt your Bisq wallet]

== Save your seed words
== Write down your seed words

Now that you've set a password, it's time to save your wallet's seed words. Go to the `Wallet seed` section of the `Account` screen and *_write down_* the words you see in the `Wallet seed words` field along with the `Wallet date`.
Now that you've set a password, it's time to write down your wallet's seed words. Go to the `Wallet seed` section of the `Account` screen and *_write down_* the words you see in the `Wallet seed words` field along with the `Wallet date`.

IMPORTANT: You should literally write your seed words and wallet date down with paper and pen. Saving them on your computer makes your computer a single point of failure: if it's ever lost, stolen, or destroyed, your bitcoin will be gone too. Storing seed words on paper prevents that from happening—just make sure you don't lose that paper!
IMPORTANT: You should _actually_ write down your seed words and wallet date with paper and pen. Saving them on your computer makes it _possible_ for a hacker to obtain through sneaky schemes like keylogging, phishing, etc. Using paper and pen eliminates every possible digital attack vector, no matter how sneaky it is.

.Save your Bisq wallet's seed words & wallet date.
image::seed-words.png[Save your Bisq wallet's seed words]
With just your wallet's seed words and date, you can restore your Bisq wallet and all its bitcoin whenever you need to. If you lose your wallet's seed words and date, you won't be able to restore your wallet, and any bitcoin in it is lost forever. So make sure you keep that paper safe!

With your wallet encrypted and your seed words saved, the bitcoin in your Bisq wallet is much more secure. Bravo!
[WARNING]
====

_This document covers just enough to help you secure your Bisq wallet. More details and general wallet safety is a much broader topic, however, so we'll expand this document over time._
Encrypting your wallet and writing down its seed words does *not* save Bisq application data such as trading history, arbitration cases, etc. For that, you need to back up the Bisq data folder:

_Subscribe to https://github.com/bisq-network/bisq-docs/issues/58[bisq-network/bisq-docs#58] for updates._
* macOS: `/Users/username/Library/Application Support/Bisq`
* Linux: `/home/username/.local/share/Bisq`
* Windows: `C:\Documents and Settings\username\AppData\Roaming\Bisq`

====

.Write down your Bisq wallet's seed words & wallet date.
image::seed-words.png[Write down your Bisq wallet's seed words]

With your wallet encrypted and your seed words written down, the bitcoin in your Bisq wallet is much more secure. Bravo!