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

Commit

Permalink
Basic instructions on Backup and Recovery
Browse files Browse the repository at this point in the history
Contains:
* explanation why backup is important
* explanation and tutorial on password protection
* explanation and tutorial on the mnemonic seed
* explanation and tutorial on the local backup
* tutorial on import backup  for Ubuntu

Needs in addition / questions:
* add detail on why the wallet creation date is important
* add detail on why seed is not enough
* local path for Windows and Mac
* tutorial on how to encrypt the backup
* screen shots of wallet interface, seed and backup files

Please check for typos and over all accordance to general layout etc.
  • Loading branch information
MaxHillebrand committed Dec 10, 2018
1 parent 99b5c58 commit 2b1b074
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Backup and Recovery.adoc
@@ -0,0 +1,19 @@
= Backup and Recovery

The Bisq client is a hot wallet, this means there are Bitcoin and BSQ private keys stored locally on your hardware. Anyone who has access to these keys has full access and can send your money. Further, if you loose these private keys, you have lost your bitcoin, and they cannot be recovered. It is thus advised to always keep keep an encrypted backup of all the sensitive data in your wallet.

This comment has been minimized.

Copy link
@ManfredKarrer

ManfredKarrer Dec 10, 2018

Member

typo with "keep keep"...


== Password

Before sending any funds to the Bisq wallet, you should first set a wallet password. This password has to be entered every time you log into the wallet, and upon every attempt to send and withdraw currency. Go to the *Account* menu and the *Wallet Password* tab. Make sure that the password is longer than 8 characters, contains upper and lower case letters, numbers and symbols. It is very important, that you write down this password, if you loose it, you will loose access to your money!!

This comment has been minimized.

Copy link
@ManfredKarrer

ManfredKarrer Dec 10, 2018

Member

"contains upper and lower case letters, numbers and symbols": We only test for the length. From my experience symbols easily cause problems when using different computers with diff. language layout.
We don't have a "show pw" option at the text fields yet so that makes it easier to set a pw u cannot enter anymore on another keyboard with another language layout (or if you switch between layouts)....

This comment has been minimized.

Copy link
@ManfredKarrer

ManfredKarrer Dec 10, 2018

Member

Not sure if anythign should be changed in the text... just a bit of background...

This comment has been minimized.

Copy link
@MaxHillebrand

MaxHillebrand Dec 10, 2018

Author Contributor

Probably best to have the same requirements in the documentation and client...

== Mnemonic Seed

Make sure that you are in a secure location and that nobody is watching the screen other than you. Anyone who has the mnemonic seed has full control over your money, thus be extremely careful with whom you share this information! However, when you loose these words, you have lost your money, so store the paper in a secure location. Go to the *Account* menue and *Wallet Seed* tab, read and confirm the security warning, and write down the 12 English words on a piece of paper with a permanent pen.

You can *restore wallets from seed words* and import money by typing the 12 words with a single space in between them. Setting the wallet creation date helps with the initial sync time.

== Local Backup

Please note, that you need to create a backup of the whole application directory to recover the valid application state and data. Importing seed words is only recommended for emergency cases, as the application will not be functional without a proper backup. You can create a complete backup of the entire wallet, in the *Account* menu and the *Backup* tab. This file contains your private keys, national currency account and trade history. *Select Backup Location* on your local computer, USB stick or CD, and click *Backup Now*. Careful though, the backup file is not encrypted, and thus anyone who has this file can take all your money!

This comment has been minimized.

Copy link
@ManfredKarrer

ManfredKarrer Dec 10, 2018

Member

This file contains your private keys, national currency account and trade history.
Maybe add "key for the Tor onion address" as that is one of the mroe important data. As well as the private keys for the P2P network communication (signarure and encryption key). Not sure if thats needed to not get too complex...


When you want to *Import a Backup*, shutdown the Bisq client and copy the entire backup data from your USB stick to /Homey/.local/share/Bisq. Make sure that you merge and replace all the existing files. Importing the backup means that you delete the current state of the wallet, so make sure you have a second backup of the status quo. Upon restart of the Bisq client, the the backe up account will automatically load.

This comment has been minimized.

Copy link
@ManfredKarrer

ManfredKarrer Dec 10, 2018

Member

/Homey/.local/share/Bisq -> ~/.local/share/Bisq
We should add the OS specific path...

Mac OSX: ~/Library/Application Support/Bisq
Linux: ~/.local/share/Bisq
Windows 7,8,10: C:\Users\username\AppData\Roaming\Bisq
Windows XP: C:\Documents and Settings\username\Application Data\Bisq

This comment has been minimized.

Copy link
@ManfredKarrer

ManfredKarrer Dec 10, 2018

Member

typo 'backe up'

0 comments on commit 2b1b074

Please sign in to comment.