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
First you need a GitHub Account https://github.com/join IMPORTANT! Your GitHub Username will become your Superalgos Username and also your Affiliate ID!
Login to your GitHub Account https://github.com/login
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
Click on Your user Icon at the top right and select "Settings" from the dropdown menu.
Click on Developer Settings
Click on Personal Access tokens
Click on Generate new token
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
Click on Generate token
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.
I assume you have a System where Docker is already installed and running. A Synology NAS in my case. Launch Docker
Click on "Registry" search for "Superalgos" and download "martinb78/superalgos-docker-develop
Click on "Image" and once the Image finished downloading click on it and click on "launch"
In the General Settings click on "Advanced Settings"
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"
At Port Settings change the lokal Ports to 18041 and 34248 or your liking or leave it on Auto.
The "default" Ports are 18041 and 34248 - if your run more than one Superalgo Bots on your system you need to change them.
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
Once you put in your GitHub details - click on Apply
You can Change the Name of the Container to your liking and click on Next
Check the details and click on "Apply"
Click on "Container" and on the name of the Container you just created and then on "Details"
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.
Seriously wait - it can take 5 to 30 Minutes
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)
Stop the Tutorial, and right click on the black Background
Click on "LAN Network" to check the Settings
Hover over "My Computer" LAN Network Node
Click on "Configure"
Type in your IP from your Server (NAS / or the computer that runs Docker) togeather with the Port
Click on the APIs Node
Click on the PLUS in the bottom left
Hover Over "New Github API and click on Configure
Check the GitHub Username and Personal Access Torken
Typein your GitHub Username and Personal Access Torken inbetween the quoation marks.
click on the "Docs" Icon at the right side.
Check out the Search and Command Field
type in "app.update" in the Command Field and hit Enter
Superalgos looks now for updates.
If a new update is found it downloads and installes it. You can see the Message "Update Done"
Scroll down all the way to the footer of the Docs.
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!