Qortal Project

This is a guide for the SinclairMATE and Plumbus devices.

1) Download the appimage if you haven’t already: https://github.com/Qortal/qortal-ui/releases/download/v1.7.1/Qortal-Setup-arm.AppImage

For SinclairMATE Versions

Simply download the file (rename it if you like, something like 'Qortal-UI' makes the most sense). Right click the file and go to properties, on the properties window there is a permissions tab, on that tab check the 'execute' box for 'owner' (see image below) then you can simply double-click and RUN the appimage, no longer needing to build from source.

For Plumbus Versions

Simply download the file (rename it if you like, something like 'Qortal-UI' makes the most sense). Right click the file, properties, then go to permissions and check the allow executing this file as a program checkbox.

For Both SinclairMATE & Plumbus Versions

When using the appimage you NO LONGER NEED the previous start script that you used to use to start the UI, you can REMOVE that start script. Please note: building from source will also continue to work, and you may build from source if you prefer. We have modified the repo that the UI uses, but even the older 'UI' repo will continue to be updated. Also, if you build from source and run with ELECTRON, it WILL auto-update that way as well.

You can add the Qortal icon to the appimage file - by right clicking on the appimage file, going to properties then clicking the icon, it will open up a browse, and you can find the Qortal UI icon in the ```UI/qortal-ui/img``` folder, select that icon, and click OK, then the appimage file will have the Qortal UI icon on it, and will look just like the previous start script looked.

(This is mostly for QORTector users, or anyone who setup their system in a similar fashion, with the Start-Qortal-UI-Electron.sh script that @crowetic wrote. That script, as well as the update script, are no longer needed if you use the new appimage. The appimage is literally an image of the Qortal UI application, it is the ONLY file you need. Simply make it executable and run it, you no longer need the from source build stuff, start script, etc.)

To re-iterate and avoid confusion - You do NOT need the previous 'Start-Qortal-UI.sh' script anymore, and you do not need the 'yarn run server' done in the terminal anymore, IF you are SWITCHING to using the .appimage version.

You run the appimage file directly, after making it executable.

2) Enter this command in terminal to update the stop script if you haven’t already:

cd qortal && rm stop.sh && wget https://raw.githubusercontent.com/Qortal/qortal/master/stop.sh && chmod +x stop.sh

3) Now download the latest jar:

wget https://github.com/Qortal/qortal/releases/download/v3.0.4/qortal.jar

4) Now stop your core:

 cd qortal && ./stop.sh

5) Open your qortal folder, replace the new jar with your old jar (delete the old jar): IT HAS TO BE TITLED THE EXACT SAME AS OLD JAR: qortal.jar

6) Now delete the db folder at the top of the qortal folder (second one down)

7) Now delete the apikey.txt

8) Now open the settings.json and change this setting to false if it reads true: “apiDocumentationEnabled” : false

Your settings will look different, feel free to copy mine if you’d like. Might even be BLANK! Just copy and paste mine:

{
"apiDocumentationEnabled" :false,
"apiEnabled": true,
"apiRestricted": false,
"autoUpdateEnabled": true,
"minBlockchainPeers": 8,
"minOutboundPeers": 16,
"maxPeers": 32,
"listenPort": 12392,
"allowConnectionsWithOlderPeerVersions": false,
"minPeerVersion": "3.0.4"
}

9) Now you can start your core. If you do not have port forwarding enabled, and have access to your router, you can set:

Inbound and outbound to: 12392

Protocol: TCP

Here’s the guide for port forwarding: Port Forwarding

If you are setting the port forward, then restart the router after doing so. Usually the router has a "save and apply" button or something, and restarts itself. Some of your routers won’t. Your router setup might look different than the picture below but same idea:

10) When you start the core, it’ll bootstrap with a pop up screen, let it run its course. May take an hour or so:

./start.sh