Comment on page

Windows Full License Software Fresh Installation Guide

Please note that this document is out of date. Please visit https://xaminer.net/docs/index-documents/ for up to date documents and guides for the Xa-Miner.

This guide will help DIY Windows users to setup a brand new provider with their Full License to run the Xa-Miner software. To do this you will need to have purchased a Full License or a Full License Upgrade from a Basic or free XM Basic license from the Xa-Miner Store. The installer supports all Windows 10 and Windows 11. Recent Windows Server versions like 2019 and 2022 will likely work as well but have not been tested formally. Versions of Windows prior to Windows 10 will also likely work but are unsupported.
The first step to install the software is to install Docker Desktop. This can be downloaded from https://docs.docker.com/desktop/install/windows-install/. After downloading and starting the the installer, you will see the following:
Ensure to leave ‘Use WSL 2 instead of Hyper-V (recommended)’ ticked.
Once it’s finished installing, you’ll see the following:
Click on Close and restart.
After restarting, run Docker Desktop. You may see an error stating Docker is not Initialized, this can be safely ignored. Once it’s started up, you will see the following message with regards WSL 2:
Follow the link in the message, there are 2 methods to installing WSL 2, either via the process documented here - https://learn.microsoft.com/en-us/windows/wsl/install or for older versions of Windows, using the following - https://learn.microsoft.com/en-us/windows/wsl/install-manual#step-4---download-the-linux-kernel-update-package
If using the 2nd method, download the installer linked in Step 4, run it and follow the prompts to install:
Once the installation is finish, click on Restart in the Docker Desktop dialog box.
After restarting, open up Docker Desktop and you should see it load up to this page:
Click on ‘Skip tutorial’ and you have completed the pre-installation steps for the Full Software.
Docker Desktop can be minimized at this point and next the Full License installer needs downloading from the XNS Console page (https://console.xns.tech/licenses). Click on the Download Latest Release button to download the Windows installer (note you will only see this if you have a full license in your account). Run the installer, you will likely see this Windows Defender pop up asking to allow Node.js Javascript Runtime through the Firewall, click on ‘Allow Access’.
A browser window will be automatically opened by the installer, showing the following, click on Advanced and then Proceed to…. (unsafe). This is just down to the self signed certificate used for the installer web page and not a security risk.
This will bring you to the initial installer page. Click on Next to proceed.
At this point the installer checks to see if Docker is installed on the system and then proceeds to the following page.
If there is no xa-miner container already detected on the system then only the Fresh Installation option will be available. If the installer is run again once there is an xa-miner container running on the system then the Configure Existing option will be available and Fresh Installation will not be available. This will be covered later in this guide. Click on Fresh Installation.
In most cases the default Application Folder will suffice but can be changed if needed. Additionally, if you want to or need to run this provider on non-default ports, click on Advanced Configuration and the following options appear where you can customise both ports and the Metadata folder.
To change any of the folder paths, click on the existing path and a pop-up window will appear (note you’ll see all other application windows minimised and just the folder selection window will be shown, once you’ve selected the folder, the other application windows will be brought back up).
If you enter ports which are in use already on the PC then the installer will check and show an error that those ports are not available.
To add in storage folders to the provider, click on Add Storage Folder (again, the pop-up will come behind the browser window). Add each storage folder you wish to provision and then click on Finish.
You will see the following page for up to a minute while the docker container is downloaded and started up.
Then you will likely see another Windows Defender pop-up asking to allow Docker Desktop Backend access through the firewall, ensure Private networks is ticked and click on Allow Access. At this point the installer is finished and you will be presented with the link to the Xa-Miner UI.
Click on the link to proceed to the Xa-Miner UI setup. The first setup screen you should see the blockchain being downloaded and then extracted, once the Next button is available, click Next to proceed.
Should the Internet Status show Not Connected in the page above, this indicates the docker container that has been installed does not have internet access, this is likely related to having a firewall issue which is blocking the docker container. Either disable the firewall or add rules to allow the docker container to have internet access (should be covered by the Windows Defender pop-up above). Click on Next.
This page is important as this is the recovery seed phrase for your provider wallet, you will need this for sending SCP coins out of the wallet so ensure to either download the PDF or write down the 29 words and keep it somewhere secure.
After clicking on Next you are taken to the registration page where you should register the Xa-Miner with the SAME e-mail address you used when ordering the license. This will help with ensuring all of your Xa-Miners and licenses are displayed together in the XNS Console page as they are linked by your e-mail address. If you are registering a 2nd or 3rd provider you should use the same e-mail address as the 1st is registered to (and the same address as any Xa-Miners you may have).
On the next screen click on Dashboard (note the Configure Ports is not possible on the Windows Xa-Miner UI and will be removed in a future version):
This will bring you to the main Xa-Miner UI Dashboard:
Here you will see at the top of the page your provider ID. This is needed to register against your Full license in the XNS Console. Simply copy it from here, go to the console.xapro.net link, select Licenses from the left menu and paste the provider ID in against your license key. If you have not yet purchased your license, please visit the store to complete your purchase.
The final step in setting up your new software Xa-Miner is to add the storage folders on the Storage menu. Selecting the Storage page from the top menu should show you the folders added earlier in the installer as below:
Here you need to enter the capacity of each folder. Note that on Windows it’s still recommended to limit the size of any one folder to 2TB so if using a larger hard drive for storage, for example a 10TB drive, make multiple folders on the drive. If need be, after creating any additional folders, simply run the installer again which will bring up the installer UI, choose Configure Existing and then add the new storage folders and click Finish. Then when you reload the Xa-Miner UI, you will see the additional folders on the Storage menu.
After entering the required value next to the folder, click on Assign and then repeat for each subsequent folder.
Congratulations, your new Xa-Miner is now fully setup. To learn more about the Xa-Miner UI and all its functions, please visit the Xa-Miner UI Walkthrough page.

Xa-Miner Maintenance Tasks

Some typical maintenance tasks which a user needs to perform on their provider will now be slightly different with the UI as compared to using the CLI provider. These are documented below.

Upgrading to a new SPD Release

When a new version of the SPD daemon is released, for example, prior to the fork in January 2023, the process for full license installations is very straightforward.
Step 1 - In Docker Desktop, stop the container by clicking on the square icon to the right of the container
Step 2 - In File Explorer, locate the xa-miner app folder, by default it's C:\ProgramData\xa-miner\app. From here go into the config directory and then spd. Inside this folder you will see 2 files, ports.yml and spd. Move the spd file to the recycle bin. If you chose a different location for the xa-miner app folder during installation of the software then you will need to browse to that folder to find spd.
Step 3 - Start up the container in Docker Desktop by clicking on the play icon
If you refresh the Xa-Miner UI now, you will see on the Dashboard the updated SPD version.

Upgrading to a new Xa-Miner Software Release

Prior to upgrading to a new Xa-Miner container version, it is worth taking a copy of the docker run command used to deploy the existing container. This can help recover in case there are any issues in deploying the updated version which a few users have seen. To do this you must be running at least Docker Desktop 4.15.0, if you are on a previous version you should update to the latest version first.
In version 4.15.0 and newer, click on the 3 dots to the right of your xa-miner container and click Copy docker run:
Then open a text editor like Notepad and paste the clipboard contents there. The output should look something like this (with your wallet seed where the blue redacted text is). Note the seed won't have any double quotes around it so you will need to add these as there are spaces in the seed for the command to work should you need it:
Save this file onto your desktop in case you need it later.
When a new version of the Software Xa-Miner is released, the process to update the software is to run the installer application used when first installing the software on the provider PC. This will bring up the installer UI as below:
Click on Next.
If there is a new version of the Xa-Miner container detected by the installer, the Update Existing button will be active and show Update Required underneath. Simply click on Update Existing, the installer will perform the upgrade (takes 1-2 mins) and when it's finished, the updated version will be running and the installer will exit. Refresh the Xa-Miner UI and the updated versions of the SPD, Supervisor and UI versions will show on the Dashboard.

Adding new storage folders

To add a new storage folder to your provider, you will first need to add the drive into Windows, create a partition, format it and assign a drive letter. If it’s a large drive over 2TB, create multiple folders, plan for 1 folder per 2TB of space on the drive.
Once you have the folders created, run the installer application again, then in the installer GUI with the 4 options as below, select Configure Existing:
After clicking on Configure Existing, you’ll be presented with the following screen showing all the existing provider’s storage folders.
Click on Add Storage Folder
Select the folder you wish to add from here and click on OK. Repeat for each folder you wish to add.
Then you will see your new folder added to the list of storage folders.
Click on Finish. This GUI will show it configuring your Xa-Miner and then will present you with the following screen at which point you can close the browser tab and access the Xa-Miner UI again.
Now return to the main Xa-Miner UI, go to the Storage page and you’ll see the added storage folder there.
Enter the size in GB you want to set the folder size to and click Assign.

Removing Storage Folders

A similar process can be used in reverse to remove storage folders in a similar way to using ‘spc host folder remove <PATH>’ from the CLI. First navigate to the Storage page on the Xa-Miner UI, find the folder from the first column you wish to remove and click on the Remove button to the right.
Any data stored in the folder being removed will be moved by spd to other folders. This process may take some time depending on how much data needs moving so it’s recommended to remove just one folder at a time.
Once the folder is removed from the Xa-Miner UI, run the installer application again and choose Configure Existing:
The following screen will show all the folders which have been added to the Xa-Miner, note if you have more than 10 drives/folders then you may need to go to the next page or change the rows per page value to All to see the one(s) you want to remove.
Simply click on the red icon in the Action column against the folder you wish to remove and then click Finish. Once all folders on a drive have been removed, the drive can be physically removed from the PC.

Recovering the Wallet Seed Phrase

Should the wallet seed phrase be forgotten, this can be recovered from the container terminal in Docker Desktop. The spc application has been added into the xa-miner container now, if spc is not available, an update of the Xa-Miner software will be required using the process above in the Upgrading to a new Xa-Miner Software Release section.
Bring up the Docker Desktop application, select Containers menu on the left side menu so you see the following page:
Click on the 3 dots on the right side of the xa-miner container and select Open in Terminal. This will give you a CLI for the container itself. Run the following command:
spc wallet seeds
This will show you the Primary Seed as below: