Merge pull request DigiByte-Core#144 from LeroyGerrits/develop

Windows setup MD

doc/windows-setup.md

@@ -0,0 +1,130 @@
+# Installing and setting up DigiByte Core in Windows
+
+- [Installing DigiByte Core](#installing-digibyte-core)
+- [Running a DigiByte node](#running-a-digibyte-node)
+- [Issue with high CPU usage](#issue-with-high-cpu-usage)
+
+## Installing DigiByte Core
+
+By itself ~4.5 GB of RAM is used by DigiByte Core. At least 6 GB or more RAM for your PC is recommended.
+Download the latest ...-win64-setup executable from the [DigiByte Core releases page](https://github.com/DigiByte-Core/digibyte/releases) and execute it. An installation wizard will open.
+
+Follow the instructions and click **Next >**.
+
+<img width="499" height="388" src="./img/windows-setup/install-1.png" />
+
+Choose a Destination Folder where DigiByte Core will be installed. By default this is **C:\Program Files\DigiByte**. Click **Next >**.
+
+<img width="499" height="388" src="./img/windows-setup/install-2.png" />
+
+Choose a Start Menu Folder for the DigiByte Core shortcut. By default this will be called **DigiByte Core**. Click **Install**.
+
+<img width="499" height="388" src="./img/windows-setup/install-3.png" />
+
+The installation wizard will now install all the necessary files. Once this is done click **Next >**.
+
+<img width="499" height="388" src="./img/windows-setup/install-4.png" />
+
+The installation is now complete, leave **Run DigiByte Core (64-bit)** checked and click **Finish**. DigiByte Core will now start.
+
+<img width="499" height="388" src="./img/windows-setup/install-5.png" />
+
+DigiByte Core is slow on startup, especially if you're starting it for the first time and the entire chain of blocks needs to be downloaded.
+
+<img width="499" height="388" src="./img/windows-setup/install-6.png" />
+
+After a while, the app will open and progress on the sync process will become visible:
+
+<img width="517" height="185" src="./img/windows-setup/install-7.png" />
+
+## Running a DigiByte node
+
+In order for your DigiByte Core installation to function as a node, some additional steps are necessary. Specifically port 12024 needs to be opened in order to allow other clients to communicate with your node.
+
+Press Windows + R to launch run, type **firewall.cpl** and click **OK**:
+
+<img width="399" height="206" src="./img/windows-setup/firewall-1.png" />
+
+In the **Windows Defender Firewall** window, click **Advanced settings** on the left:
+
+<img width="899" height="558" src="./img/windows-setup/firewall-2.png" />
+
+In the **Windows Defender Firewall with Advanced Security** window, click **Inbound Rules** in the left navigation pane, then click **New Rule** in the right navigation pane (Actions):
+
+<img width="1057" height="499" src="./img/windows-setup/firewall-3.png" />
+
+In the **New Inbound Rule Wizard** window, step **Rule Type**, select **Port** and click **Next >**:
+
+<img width="714" height="581" src="./img/windows-setup/firewall-4.png" />
+
+In the **New Inbound Rule Wizard** window, step **Protocol and Ports**, select **TCP**, select **Specify local ports**, fill in **12024** and click **Next >**:
+
+<img width="714" height="581" src="./img/windows-setup/firewall-5.png" />
+
+In the **New Inbound Rule Wizard** window, step **Action**, select **Allow the connection** and click **Next >**:
+
+<img width="714" height="581" src="./img/windows-setup/firewall-6.png" />
+
+In the **New Inbound Rule Wizard** window, step **Profile**, check all 3 checkboxes and click **Next >**:
+
+<img width="714" height="581" src="./img/windows-setup/firewall-7.png" />
+
+In the **New Inbound Rule Wizard** window, step **Name**, give this rule a custom name. Give it a name that is easily identified for this purpose, such as **DigiByte Core Node (incoming port 12024)** Click **Finish**:
+
+<img width="714" height="581" src="./img/windows-setup/firewall-8.png" />
+
+Back in the **Windows Defender Firewall with Advanced Security** window, double click the rule you just added:
+
+<img width="1057" height="499" src="./img/windows-setup/firewall-9.png" />
+
+In the **DigiByte Core Node (incoming port 12024) Properties** window, go to tab **Programs and Services**, select **This program:** and click **Browse...**:
+
+<img width="433" height="581" src="./img/windows-setup/firewall-10.png" />
+
+Locate **digibyte-qt.exe**, this executable is in the install directory you chose to install DigiByte Core in an earlier step. By default this is **C:\Program Files\DigiByte**. Back in the **DigiByte Core Node (incoming port 12024) Properties** window after selecting the file, click **OK**:
+
+<img width="433" height="581" src="./img/windows-setup/firewall-11.png" />
+
+You have now made an **inbound** rule. The exact same steps need to be taken for an **outbound** rule. Back in the **Windows Defender Firewall with Advanced Security** window, click **Outbound Rules** in the left navigation pane, then click **New Rule** in the right navigation pane (Actions):
+
+<img width="1057" height="499" src="./img/windows-setup/firewall-12.png" />
+
+The rest of the steps are exactly the same as when you would add an **inbound** rule. 
+
+Open DigiByte Core and check the node icon in the bottom right of the screen. All 4 nodes should now be colored:
+
+<img width="102" height="42" src="./img/windows-setup/firewall-13.png" />
+
+You can also click the icon and click **Show Peers tab** in the context menu:
+
+<img width="231" height="85" src="./img/windows-setup/firewall-14.png" />
+
+In the **Node window** window, go to tab **Information** and check if **Number of connections** has both incoming and outgoing connections:
+
+<img width="743" height="463" src="./img/windows-setup/firewall-15.png" />
+
+If the amount of incoming connections remains 0, that means your node still isn't completely accessible and you likely need to apply port forwarding in your router. Refer to your ISP or router manufacturer's manual to do this as this varies per router model/manufacturer.
+
+## Issue with high CPU usage
+
+Typically DigiByte Core consumes ~4.5 GB of RAM on Windows, but CPU usage should remain lower than 1%. If DigiByte Core is consuming large amounts of CPU capacity (10% - 30%), it's likely that Windows' built-in firewall and antivirus may be interfering. Adding an exclusion to **digibyte-qt.exe** will most likely solve this.
+
+Open the **Windows Security** app. You can find it by opening the start menu and typing **Security**:
+
+<img width="780" height="615" src="./img/windows-setup/exclusion-1.png" />
+
+In the **Windows Security** window, click **Virus & threat protection** in the left navigation pane, locate **Virus & threat protection settings** in the middle pane and click **Manage settings** below it:
+
+<img width="865" height="792" src="./img/windows-setup/exclusion-2.png" />
+
+Scroll down in the middle pane, locate **Exclusions** and click **Add or remove exclusions** below it:
+
+<img width="914" height="930" src="./img/windows-setup/exclusion-3.png" />
+
+Click **+ Add an exclusion** and select **File** in the context menu that appears:
+
+<img width="658" height="446" src="./img/windows-setup/exclusion-4.png" />
+
+Locate **digibyte-qt.exe**, this executable is in the install directory you chose to install DigiByte Core in an earlier step. By default this is **C:\Program Files\DigiByte**. Back in the **Windows Security** window, the file should now be shown:
+
+<img width="869" height="409" src="./img/windows-setup/exclusion-5.png" />