Skip to content

Latest commit

 

History

History
159 lines (107 loc) · 8.54 KB

README.md

File metadata and controls

159 lines (107 loc) · 8.54 KB
Raw

SUPERALGOS Node based Crypto Trading Bot

Setup to Develop Superalgos in a Docker Container

DEVELOPMENT ENVIROMENT with a Docker Container

https://github.com/Superalgos/Superalgos

This is a Docker Image with Linux Apline, Node.js, Git and Python3. Once the Image is launched as a container you can mount a local folder "app" to it. The Container will then download the latest Superalgos Develop version into that mounted folder.

The Dockerfiles are from here https://github.com/mARTin-B78/Superalgos-Docker-Develop

Preparation - Github Account / Fork Superalgos / Personal Access Token

First you need a GitHub Account https://github.com/join IMPORTANT! Your GitHub Username will become your Superalgos Username and also your Affiliate ID!

001 Login to your GitHub Account https://github.com/login

001b You need to "Fork" Superalgos/Superalgos to your Account - So search for it and then click on "Fork"

Now you need to create a Github Personal Access Token

002 Click on Your user Icon at the top right and select "Settings" from the dropdown menu.

003 Click on Developer Settings

004 Click on Personal Access tokens

005 Click on Generate new token

006 Type in a Name for your Token like "Superalgos" Set the Expiration Time, I picked "no expiration" Check the Box at "repo" and "workflow" and scroll down to the bottom

007 Click on Generate token

008 Copy your token and your GitHub Username and the E-Mail adress you used to signup at Github and Save it somewhere save for later.

Installation in a Docker System

I assume you have a System where Docker is already installed and running. A Synology NAS in my case. Launch Docker

010b Click on "Registry" search for "Superalgos" and download "martinb78/superalgos-docker-develop

010 Click on "Image" and once the Image finished downloading click on it and click on "launch"

011 In the General Settings click on "Advanced Settings"

012 At "Volume" click on "Add Folder", pick a folder on Your System where you want the Superalgos files to be stored and add the Mount path "/app"

013 At Port Settings change the lokal Ports to 18041 and 34248 or your liking or leave it on Auto.

014 The "default" Ports are 18041 and 34248 - if your run more than one Superalgo Bots on your system you need to change them.

015 Click on the "Enviroment" tab and

  • Paste in your GitHub Username
  • Paste in the E-Mail adress you used to signup at Github
  • Paste in your GitHub Personal Access Torken
  • and Paste in your Github Username inbetween the Github Repository_URL you need to have Forked Superalgos/Superalgos for this to work

016 Once you put in your GitHub details - click on Apply

017 You can Change the Name of the Container to your liking and click on Next

018 Check the details and click on "Apply"

019 Click on "Container" and on the name of the Container you just created and then on "Details"

020 Click on "Terminal" and be patient. Now the Container downloads Superalgos from your Fork and installes it into the Mounted Folder you picked earlier. That can take a while. Wait until it is finished and you see "Superalgos Platform App is Running" in the Terminal Window.

wait Seriously wait - it can take 5 to 30 Minutes

Setup Superalgos to be able to Contribute and Commit changes

021 Launch a Webbrowser (prefered googel chrome) and type in the IP of your NAS or Computer that Runs Docker togeather with the default Superalgos Port (or the one you picked earlier)

022 Stop the Tutorial, and right click on the black Background Click on "LAN Network" to check the Settings

023 Hover over "My Computer" LAN Network Node

024 Click on "Configure"

025 Type in your IP from your Server (NAS / or the computer that runs Docker) togeather with the Port

026 Click on the APIs Node

027 Click on the PLUS in the bottom left

028 Hover Over "New Github API and click on Configure

029 Check the GitHub Username and Personal Access Torken

030 Typein your GitHub Username and Personal Access Torken inbetween the quoation marks.

Check if you are able to Contribute with Superalgos

031 click on the "Docs" Icon at the right side.

032 Check out the Search and Command Field

033 type in "app.update" in the Command Field and hit Enter

034 Superalgos looks now for updates.

035 If a new update is found it downloads and installes it. You can see the Message "Update Done"

036 Scroll down all the way to the footer of the Docs.

037 Click on the Flag of your Language you want to use / Translate and click on eighter "Plugins-Docs" or "Develop" on "Choose the Current Branch" and "Contribution Branch"

DONE!