Installation - Sjakil/gunthy-gui GitHub Wiki

1) What are API keys and how to use them? (optional)

If you are familiar with API keys and how to use them, you can skip this part (although it might be good to do it nonetheless). Otherwise, it is highly recommend you read this first: API keys.

2) Install and configure GUI (required)

  • Download the latest version from releases
  • Unzip the archive directly into your Gunbot folder
    • The GUI and Gunbot need to share the same folder in order to work
  • Start the GUI executable, and follow any instructions
    • Run it from a console / terminal window
  • If no errors were encountered, the GUI should start a web server
  • Copy the web server address given by the GUI and visit it
    • If possible, the GUI will open a browser window
  • You should now see the SSL configuration screen
    • If you want to use your own certificate, you can upload it here
    • Your next best choice is to use self signed certificates
    • Leaving SSL disabled poses risks, please be careful
    • For more help check out the wiki page: SSL Configuration
  • After saving the SSL configuration, the GUI now needs to be restarted
  • Revisit the page in your browser and refresh
    • If you've enabled SSL, make sure to switch from HTTP to HTTPS
  • The GUI should now present the initial configuration window
    • Please use a completely new API key for the GUI in order to avoid issues (like 422 errors)
    • If you are unsure how to set up your API keys, check out this wiki page: API keys
  • Complete it and then save it, restart the GUI again

3) Install PM2 (required / optional)

As of version 0.96, the GUI no longer requires PM2 to be installed on your system. You can still install it if you want to of course. If you do, please install PM2 version 2.5.0 using the commands below.

The GUI will not ask for PM2 before completing the initial setup above, but it will require NodeJS and PM2 to operate your bots (version 0.95 and below only).

  • First, download and install NodeJS.
  • Second, use NPM to download and install PM2 globally with following command:
npm install [email protected] -g

Please make sure you use version 2.5.0, later versions break support for reading gunbot log output.

  • And finally, make sure that you've started a PM2 instance by running following command:
pm2 ping

4) Keeping GUI alive (optional)

If you're looking for a way to keep the GUI running without having an open console or aplication window, use the instructions on the "Keeping GUI alive" wiki entry page.