From 993f3fdcf06d991f13ba162d59602d444e62b4a5 Mon Sep 17 00:00:00 2001 From: d3spwn Date: Wed, 23 Jan 2019 10:54:53 +0100 Subject: [PATCH 1/5] Add mention of Windows installation documentation. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 191085a..9dd66d4 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Do note, Python 2 is incompatible with the Qt GUI. You should now be able to run the scripts like `python wallet-tool.py` etc., just as you did in the previous Joinmarket version. -Alternative to this "quickstart" (including for MacOS): follow the [install guide](docs/INSTALL.md). +Alternative to this "quickstart" (including for Windows and MacOS): follow the [install guide](docs/INSTALL.md). ### Usage From 769990dba75be6938a7459ed7b8edd02c23431a3 Mon Sep 17 00:00:00 2001 From: d3spwn Date: Wed, 23 Jan 2019 12:08:26 +0100 Subject: [PATCH 2/5] Add section about installing on Windows --- docs/INSTALL.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index c9d8342..b7e9e78 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -154,3 +154,28 @@ the local code would not have effect until the packages are reinstalled. Using `--develop` causes a `.egg-link` file to be added to `site-packages` for each package. The `.egg-link` file acts like a symlink pointing to the local code. This means any changes you make to the code will have effect immediately. + +### Installation on Windows + +Installing JoinMarket on Windows using the following method requires Windows 10 version 1607 or later. + +#### Enable Windows Subsystem for Linux + +> note: a more detailed guide can be found [here](https://github.com/michaeltreat/Windows-Subsystem-For-Linux-Setup-Guide/blob/master/readmes/02_WSL_Ubuntu_setup.md). + + 1. Open the `Control Panel` and navigate to `Programs`, `Programs and Features`, `Turn Windows features on or off`. + 2. Select `Windows Subsystem for Linux` and click `OK`. + 3. When asked, choose to restart. + +#### Install Ubuntu from the Windows Store +1. Open the `Windows Store`, search for `Ubuntu 18.04 LTS` and click `Get`. +> note: other distributions are available, but this is the only one tested +2. When finished downloading click `Launch`. +3. A window should pop up, telling your `Installing, this may take a few minutes...` +4. After installation is done, you'll be asked to provide a `UNIX username` and `UNIX password`. This will be the administrator account for the Ubuntu installation. +5. Finish the installation with updating the software within Ubuntu by typing the command `sudo apt update && sudo apt upgrade -y`. When asked, type the password provided earlier. + +#### Installing JoinMarket +At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md) or [Installation on Linux](#Installation on Linux) section in this file. + +todo: add note about installing and configuring bitcoin core From 275d24b2d6e2f82cfd98b2f303cb0466a99ebf43 Mon Sep 17 00:00:00 2001 From: d3spwn Date: Wed, 23 Jan 2019 12:15:04 +0100 Subject: [PATCH 3/5] Moved section to the right place --- docs/INSTALL.md | 52 +++++++++++++++++++++++++------------------------ 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index b7e9e78..2ba21b0 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -112,7 +112,33 @@ At this point you should see `(jmvenv)` at the beginning of your command prompt. cd scripts python joinmarket-qt.py ``` -Alternative/custom installation: + +### Installation on Windows + +Installing JoinMarket on Windows using the following method requires Windows 10 version 1607 or later. + +#### Enable Windows Subsystem for Linux + +> note: a more detailed guide can be found [here](https://github.com/michaeltreat/Windows-Subsystem-For-Linux-Setup-Guide/blob/master/readmes/02_WSL_Ubuntu_setup.md). + + 1. Open the `Control Panel` and navigate to `Programs`, `Programs and Features`, `Turn Windows features on or off`. + 2. Select `Windows Subsystem for Linux` and click `OK`. + 3. When asked, choose to restart. + +#### Install Ubuntu from the Windows Store +1. Open the `Windows Store`, search for `Ubuntu 18.04 LTS` and click `Get`. +> note: other distributions are available, but this is the only one tested +2. When finished downloading click `Launch`. +3. A window should pop up, telling your `Installing, this may take a few minutes...` +4. After installation is done, you'll be asked to provide a `UNIX username` and `UNIX password`. This will be the administrator account for the Ubuntu installation. +5. Finish the installation with updating the software within Ubuntu by typing the command `sudo apt update && sudo apt upgrade -y`. When asked, type the password provided earlier. + +#### Installing JoinMarket +At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md) or [Installation on Linux](#Installation on Linux) section in this file. + +todo: add note about installing and configuring bitcoin core + +### Alternative/custom installation: #### Installing the daemon separately @@ -155,27 +181,3 @@ Using `--develop` causes a `.egg-link` file to be added to `site-packages` for e The `.egg-link` file acts like a symlink pointing to the local code. This means any changes you make to the code will have effect immediately. -### Installation on Windows - -Installing JoinMarket on Windows using the following method requires Windows 10 version 1607 or later. - -#### Enable Windows Subsystem for Linux - -> note: a more detailed guide can be found [here](https://github.com/michaeltreat/Windows-Subsystem-For-Linux-Setup-Guide/blob/master/readmes/02_WSL_Ubuntu_setup.md). - - 1. Open the `Control Panel` and navigate to `Programs`, `Programs and Features`, `Turn Windows features on or off`. - 2. Select `Windows Subsystem for Linux` and click `OK`. - 3. When asked, choose to restart. - -#### Install Ubuntu from the Windows Store -1. Open the `Windows Store`, search for `Ubuntu 18.04 LTS` and click `Get`. -> note: other distributions are available, but this is the only one tested -2. When finished downloading click `Launch`. -3. A window should pop up, telling your `Installing, this may take a few minutes...` -4. After installation is done, you'll be asked to provide a `UNIX username` and `UNIX password`. This will be the administrator account for the Ubuntu installation. -5. Finish the installation with updating the software within Ubuntu by typing the command `sudo apt update && sudo apt upgrade -y`. When asked, type the password provided earlier. - -#### Installing JoinMarket -At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md) or [Installation on Linux](#Installation on Linux) section in this file. - -todo: add note about installing and configuring bitcoin core From 8e6a099a3f1848fa947ee1087e9ec3ae2a135ee2 Mon Sep 17 00:00:00 2001 From: d3spwn Date: Wed, 23 Jan 2019 15:35:38 +0100 Subject: [PATCH 4/5] Addes section about installing and configuring Bitcoin Core --- docs/INSTALL.md | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 2ba21b0..1ff2619 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -114,11 +114,9 @@ At this point you should see `(jmvenv)` at the beginning of your command prompt. ``` ### Installation on Windows - -Installing JoinMarket on Windows using the following method requires Windows 10 version 1607 or later. +> note: Installing JoinMarket on Windows using the following method requires Windows 10 version 1607 or later. #### Enable Windows Subsystem for Linux - > note: a more detailed guide can be found [here](https://github.com/michaeltreat/Windows-Subsystem-For-Linux-Setup-Guide/blob/master/readmes/02_WSL_Ubuntu_setup.md). 1. Open the `Control Panel` and navigate to `Programs`, `Programs and Features`, `Turn Windows features on or off`. @@ -134,9 +132,37 @@ Installing JoinMarket on Windows using the following method requires Windows 10 5. Finish the installation with updating the software within Ubuntu by typing the command `sudo apt update && sudo apt upgrade -y`. When asked, type the password provided earlier. #### Installing JoinMarket -At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md) or [Installation on Linux](#Installation on Linux) section in this file. +At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md) or [Installation on Linux](#nstallation-on-linux) section of this file. + +#### Installing Bitcoin Core +If you haven't done so yet, install Bitcoin Core as described [here](https://bitcoin.org/en/full-node#windows-10). After starting it for the first time, it will start the Initial Block Download. JoinMarket cannot be used until this is finished. More information on that can be found [here](https://bitcoin.org/en/full-node#initial-block-downloadibd). + +#### Configuring Bitcoin Core +Bitcoin Core needs to be configured to allow JoinMarket to connect to it. From the `Settings` menu choose `Options` and click `Open Configuration File`. Add `server=1`, save and close the file. After that restart Bitcoin Core. + +#### Configuring JoinMarket +Lastly we must configure JoinMarket to allow it to connect to Bitcoin Core. Refer to the [this](USAGE.md#zeroth-step-configuring-for-bitcoin-core) section in the usage guide. + +Edit your `joinmarket.cfg` file (in Ubuntu) and replace the following lines in the section `[BLOCKCHAIN]` + +``` +rpc_user = bitcoin +rpc_password = password +``` + +with + +``` +#rpc_user = bitcoin +#rpc_password = password +rpc_cookie_file = /.cookie +``` + +The location of the data directory was chosen when Bitcoin Core was first run. The default is `C:\Users\\AppData\Roaming\Bitcoin`. In Ubuntu this would be `/mnt/c/Users//AppData/Roaming/Bitcoin`. Assuming your username is `Alice` the full line would be -todo: add note about installing and configuring bitcoin core +``` +rpc_cookie_file = /mnt/c/Users/Alice/AppData/Roaming/Bitcoin/.cookie +``` ### Alternative/custom installation: From cbc39bc2cdd67418272d019e4f92695ec3cbbdab Mon Sep 17 00:00:00 2001 From: d3spwn Date: Wed, 23 Jan 2019 15:38:49 +0100 Subject: [PATCH 5/5] Fix links --- docs/INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 1ff2619..b1a1c6b 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -132,7 +132,7 @@ At this point you should see `(jmvenv)` at the beginning of your command prompt. 5. Finish the installation with updating the software within Ubuntu by typing the command `sudo apt update && sudo apt upgrade -y`. When asked, type the password provided earlier. #### Installing JoinMarket -At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md) or [Installation on Linux](#nstallation-on-linux) section of this file. +At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the [readme file](../README.md#quickstart) or [Installation on Linux](#installation-on-linux) section of this file. #### Installing Bitcoin Core If you haven't done so yet, install Bitcoin Core as described [here](https://bitcoin.org/en/full-node#windows-10). After starting it for the first time, it will start the Initial Block Download. JoinMarket cannot be used until this is finished. More information on that can be found [here](https://bitcoin.org/en/full-node#initial-block-downloadibd).