# Introduction Documentation on the Unofficial Gunbot Docker container GitHub Repository: Docker Hub: ## Overview I have been a [Gunbot](https://gunthy.org/gunbot/) community member since 2019 and decided to help the community out with a need of a standardized containizered app of Gunbot for an easy to run setup. This setup will allow for a vanilla, Gunbot setup, in less than a minute, allowing fully customizations, while providing one with the latest version, at all times. ## Highlights Key capabilities of this Gunbot container: * Auto-builds with the latest **stable** version of Gunbot, use the tag `:latest` * Auto-builds with the latest **beta** version of Gunbot, use the tag `:beta` * Multi-platform support ( `amd64` and `arm64` ) * Supports HTTPS by default with the Web GUI * [Gunthy Marketplace](https://marketplace.gunthy.io/) custom scripts are supported (requires using persistent data) * Listed on the Gunthy Marketplace, [check us out](https://marketplace.gunthy.io/extras/GunbotDocker) ## What is Gunbot Gunbot is an easy-to-use, advanced crypto trading bot. You define or select a trading strategy and watch Gunbot trade. Enabling you to get up to hundreds of profitable trades per day, 24/7. Learn more about Gunbot at ## Gunbot Licensing First, Gunbot requires licensing to run and please check out the latest licensing details on the Gunbot Wiki at [Gunbot About Blockchain Licensing](https://wiki.gunthy.org/about/system-requirements/license-info#blockchain-based-license-system). To acquire a license, please reach out to a [Gunbot Reseller](https://gunthy.org/resellers/) for more information. ## Disclosures {% hint style="warning" %} NOTES * The information provided on this wiki does not constitute investment advice, financial advice, trading advice, or any other sort of advice, and you should not treat any of the wiki's content as such. Gunbot does not recommend that any asset should be bought, sold, or held by you. Nothing on this website should be taken as an offer to buy, sell or hold a cryptocurrency. * Do conduct your own due diligence and consult your financial advisory before making any investment decision. Gunbot will not be held responsible for the investment decisions you make. * I am not responsible for any data, financial impact, or harm as a result of using the container. {% endhint %} # To Do Roadmap, Feature Requests, Planned Items Planned items to be implemented: * [ ] Rootless Docker Support (WIP) * [x] Update guide for Gunthy Marketplace custom scripts support * [x] Work with more complex add-on authors (as requested, as willing) to integrate Would you like a feature to be added? Please file a request on the [GitHub site](https://github.com/computeronix/docker-gunbot/issues). # Quickstart Guide How to get up and going quickly ## How to Get Started[​](https://marketplace.gunthy.io/extras/GunbotDocker#how-to-get-started) ### Docker Hub Repo Access the [Docker Hub](https://hub.docker.com/r/computeronix/gunbot) to review tags and all the details of the container. ### Quick Start[​](https://marketplace.gunthy.io/extras/GunbotDocker#quick-start) For the automated, quick start route, with your container tool, simply run ``` docker run -d computeronix/gunbot:latest ``` Once the image is downloaded, it will run and auto-start in usually about one minute or less. If the port, by default 5000, is open on the host, and pass-thru the container, go to `https://IPofCONTAINER:5000` (localhost could be used if local environment) {% hint style="info" %} PRO TIP: if this is the first time using Gunbot, or you need assistance setting up the config, open the port and pass it through the container, then use the Web GUI to set it up. The Gunbot team has done an outstanding job with the Web GUI! DO NOT forget to use the persistent data option below if you plan to keep your data {% endhint %} ### Example with persistent data and pass-through ``` docker run -d -p 5010:5000 -v "/host/directory/to/volume:/mnt/gunbot" computeronix/gunbot:latest ``` In the above example, Gunbot would be available on `https://IPofCONTAINER:5010` and data would persist on the mounted directory `/host/directory/to/volume`. # Advanced Setup Additional options and parameters available for advanced builds ## Interrupt the startup Interrupt the auto-start with the following command and feel free to do what you want: `docker run -it computeronix/gunbot:latest sh` You will then get shell access to the container and can do what you want. {% hint style="info" %} Run the file `/opt/gunbot/startup.sh` when ready to fire off the bot {% endhint %} ## Defaults Default values that are out of the box: * Port: 5000 (TCP) * HTTPS is enabled with a self-signed certificate * Gunbot Betas are supported (requires using Persistant Data) * Supports custom SSL certificate (requires using Persistant Data) ## Command Options Supported Supported command options as part of the Docker container: ### Support Host Time Gunbot is a time sensitive application, as accurate timestamps are critical to communicate to exchanges, and depending on how long the container runs for you "may" want to allow the permission to change the system time, OR, you may want to consider getting a fresh container every so often (no longer than every 24 hours). The parameter `--cap-add=SYS_TIME` is supported to allow the change time permission to occur on the container, but this may not work on all hosting platforms. Supported parameter: `--cap-add=SYS_TIME` ### Support Website GUI Pass-Through Port You may want to allow passing through your Website GUI port to getting access to the Website Management GUI of your Gunbot. By default the port is TCP 5000, run this command to pass-through the port `-p 5000:5000` and this can be customized as needed. The first `5000` is the HOST port and can be the port used to access from your host (Internet) and the second `5000` is the port configured in your Gunbot config (by default `5000`). Supported parameter: `-p 5000:5000` {% hint style="info" %} Do not forget to open any firewall restrictions on your HOST network (5000 by default, port on left, source port). {% endhint %} {% hint style="warning" %} Gunbot is intended to run on your local system. Making the Gunbot GUI available from outside networks is inherently risky, only do so on your own responsibility. Considerable efforts went into securing the GUI, but please understand that achieving 100% security is not realistic. {% endhint %} ### Support Persistent Data Containers are ephermal, which means when they complete their task, they end, and all associated data is lost. If there is data you want to keep as part of the container ending, you will want to mount a directory to preserve this data. Gunbot Docker container supports persistence if you decide you want to keep your Gunbot data. To support persistence add the parameter `-v "/host/directory/to/volume:/mnt/gunbot"` and the following directories and files in `/mnt/gunbot` will be redirected and saved to your mounted volume, `/host/directory/to/volume`. Persistent Gunbot Directories and Files: * ssl.config (to customize the created self-signed SSL certificate \[optional]) * localhost.key (to replace the self-signed SSL certificate) * localhost.crt (to replace the self-signed SSL certificate) * json directory * logs directory * backups directory * customStrategies directory * user\_modules directory * config.js * UTAconfig.json * autoconfig.json * gunbotgui.db * new\_gui.sqlite {% hint style="warning" %} DO NOT use more than one instance to the exact same `/host/directory/to/volume/`, instead make sure you use different directories, for example you could use subdirectories in `/host/directory/to/volume/sub1 sub2 sub3 etc` so multiple running containers will not conflict with each other. {% endhint %} Supported parameter: `-v "/host/directory/to/volume:/mnt/gunbot"` # Add-ons Supported add-ons for the Gunbot Docker container {% content-ref url="/pages/4I6fOYy6XT1zOEGqitAG" %} [zyb0t](/add-ons/zyb0t) {% endcontent-ref %} # zyb0t GitHub Repository: Docker Hub: ## Overview zyb0t is an add-on for the Gunbot trading system. ## Highlights Key capabilities of this container: * Auto-builds with the latest **stable** version of Gunbot, use the tag `:latest` * Auto-builds with the latest **beta** version of Gunbot, use the tag `:beta` * Multi-platform support ( `amd64` and `arm64` ) * Supports the latest version of the zyb0t releases. ## Licensing zyb0t requires a license. Please contact zy0n to inquire about a license. ## How to Get Started[​](https://marketplace.gunthy.io/extras/GunbotDocker#how-to-get-started) ### Docker Hub Repo Access the [Docker Hub](https://hub.docker.com/r/computeronix/zyb0t) to review tags and all the details of the container. ### Quick Start[​](https://marketplace.gunthy.io/extras/GunbotDocker#quick-start) For the automated, quick start route, with your container tool, simply run ``` docker run -d computeronix/zyb0t:latest ``` Once the image is downloaded, it will run and auto-start in usually about one minute or less. If the port, by default 5000, is open on the host, and pass-thru the container, go to `https://IPofCONTAINER:5000` (localhost could be used if local environment) {% hint style="info" %} PRO TIP: if this is the first time using Gunbot, or you need assistance setting up the config, open the port and pass it through the container, then use the Web GUI to set it up. The Gunbot team has done an outstanding job with the Web GUI! DO NOT forget to use the persistent data option below if you plan to keep your data {% endhint %} ### Example with persistent data and pass-through ``` docker run -d -p 5010:5000 -v "/host/directory/to/volume:/mnt/gunbot" computeronix/zyb0t:latest ``` In the above example, Gunbot would be available on `https://IPofCONTAINER:5010` and data would persist on the mounted directory `/host/directory/to/volume`. ## Support * Join the Telegram Community * Submit issues/feedback/feature requests at the \[[GitHub site](https://github.com/computeronix/docker-zyb0t/issues)] # ARS GitHub Repository: [https://github.com/computeronix/docker-](https://github.com/computeronix/docker-zyb0t)[ars](https://github.com/computeronix/docker-ars) Docker Hub: [https://hub.docker.com/r/computeronix/](https://hub.docker.com/r/computeronix/zyb0t)[ars](https://hub.docker.com/r/computeronix/ars) ## Overview ARS is an add-on for the Gunbot trading system. ## Highlights Key capabilities of this container: * Auto-builds with the latest **stable** version of Gunbot, use the tag `:latest` * Auto-builds with the latest **beta** version of Gunbot, use the tag `:beta` * Multi-platform support ( `amd64` and `arm64` ) * Supports the latest version of the ARS releases. ## Licensing ARS requires a license. A license can be acquired from the [Gunthy Marketplace](https://marketplace.gunthy.io/for-gunbot-market-maker/ars-intelligent-trend-algo). ## How to Get Started[​](https://marketplace.gunthy.io/extras/GunbotDocker#how-to-get-started) ### Docker Hub Repo Access the [Docker Hub](https://hub.docker.com/r/computeronix/ars) to review tags and all the details of the container. ### Quick Start[​](https://marketplace.gunthy.io/extras/GunbotDocker#quick-start) For the automated, quick start route, with your container tool, simply run ``` docker run -d computeronix/ars:latest ``` Once the image is downloaded, it will run and auto-start in usually about one minute or less. If the port, by default 5000, is open on the host, and pass-thru the container, go to `https://IPofCONTAINER:5000` (localhost could be used if local environment) {% hint style="info" %} PRO TIP: if this is the first time using Gunbot, or you need assistance setting up the config, open the port and pass it through the container, then use the Web GUI to set it up. The Gunbot team has done an outstanding job with the Web GUI! DO NOT forget to use the persistent data option below if you plan to keep your data {% endhint %} ### Example with persistent data and pass-through ``` docker run -d -p 5010:5000 -v "/host/directory/to/volume:/mnt/gunbot" computeronix/ars:latest ``` In the above example, Gunbot would be available on `https://IPofCONTAINER:5010` and data would persist on the mounted directory `/host/directory/to/volume`. ## Support * Review the ARS documentation for setup, ask crazymop or bestnaf for a copy of it * Join the Telegram Community, ask crazymop or bestnaf for access to it. * Submit issues/feedback/feature requests at the \[[GitHub site](https://github.com/computeronix/docker-ars/issues)] # Docker Stats Monitoring page for the containers ## Gunbot Container Statistics [![docker build status](https://camo.githubusercontent.com/45ec49258777dedf8ef3adc631831db67ea2bf8e793ccd9e65803affc90a9c6d/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6275696c642f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/45ec49258777dedf8ef3adc631831db67ea2bf8e793ccd9e65803affc90a9c6d/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6275696c642f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963) [![docker build type](https://camo.githubusercontent.com/6521e98205d1cc24ddcd7c1e38e2e950178d00cf481c23760164ea3c21aa111c/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6175746f6d617465642f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/6521e98205d1cc24ddcd7c1e38e2e950178d00cf481c23760164ea3c21aa111c/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6175746f6d617465642f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963) [![docker build pulls](https://camo.githubusercontent.com/5b62a861b61ce6234d2195057f10ca93e0a7712f298b5582cc5ccc0eef98bb8e/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f70756c6c732f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/5b62a861b61ce6234d2195057f10ca93e0a7712f298b5582cc5ccc0eef98bb8e/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f70756c6c732f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963) [![docker build open issues](https://camo.githubusercontent.com/ed39b7de03a63b7113989498cafb30ca21a453b6cc431fcbede493041eab147e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f636f6d70757465726f6e69782f646f636b65722d67756e626f743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/ed39b7de03a63b7113989498cafb30ca21a453b6cc431fcbede493041eab147e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f636f6d70757465726f6e69782f646f636b65722d67756e626f743f7374796c653d706c6173746963) [![docker build stars](https://camo.githubusercontent.com/86aea690a9960a6f192a8166edc3b945822c88c586d449302ac0439346b3a657/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f73746172732f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/86aea690a9960a6f192a8166edc3b945822c88c586d449302ac0439346b3a657/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f73746172732f636f6d70757465726f6e69782f67756e626f743f7374796c653d706c6173746963) ### Stable Release [![docker build version by latest stable version](https://camo.githubusercontent.com/4653fd5f9e46d224a52c3f1488ba1788e8fd9af0c21fad875e5ffc6a55584cf4/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f67756e626f742f6c61746573743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/4653fd5f9e46d224a52c3f1488ba1788e8fd9af0c21fad875e5ffc6a55584cf4/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f67756e626f742f6c61746573743f7374796c653d706c6173746963) [![docker build size by latest stable version](https://camo.githubusercontent.com/f276b4e32deceff1fe2c691b6699b7f8cf7a4b42b0748cf5cce42247cf166cf9/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f67756e626f742f6c61746573743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/f276b4e32deceff1fe2c691b6699b7f8cf7a4b42b0748cf5cce42247cf166cf9/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f67756e626f742f6c61746573743f7374796c653d706c6173746963) ### Beta Release [![docker build version by latest beta version](https://camo.githubusercontent.com/2189ce2537970198cb1d105649c036b1f8294f78300dc88186da121816cc58ab/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f67756e626f742f626574613f7374796c653d706c6173746963)](https://camo.githubusercontent.com/2189ce2537970198cb1d105649c036b1f8294f78300dc88186da121816cc58ab/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f67756e626f742f626574613f7374796c653d706c6173746963) [![docker build size by latest beta version](https://camo.githubusercontent.com/da78c7237833fe2b94ca43985220e2621334daebd596a044e4001191074162bf/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f67756e626f742f626574613f7374796c653d706c6173746963)](https://camo.githubusercontent.com/da78c7237833fe2b94ca43985220e2621334daebd596a044e4001191074162bf/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f67756e626f742f626574613f7374796c653d706c6173746963) ## ## zyb0t Container Statistics [![docker build status](https://camo.githubusercontent.com/c3f4ac7f4c8fa1a4f3467decf2e78c65168eefbd3e55e2cc382ed8090ad02bb7/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6275696c642f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/c3f4ac7f4c8fa1a4f3467decf2e78c65168eefbd3e55e2cc382ed8090ad02bb7/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6275696c642f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963) [![docker build type](https://camo.githubusercontent.com/473223570c6d94f962a021c6a256bf4bbcc9a34c3547f3f7de20fcce0b975b7b/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6175746f6d617465642f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/473223570c6d94f962a021c6a256bf4bbcc9a34c3547f3f7de20fcce0b975b7b/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6175746f6d617465642f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963) [![docker build pulls](https://camo.githubusercontent.com/7121bd016603b086f44d3357152a701be6b40b142c5209cf2f611fda6f1808dd/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f70756c6c732f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/7121bd016603b086f44d3357152a701be6b40b142c5209cf2f611fda6f1808dd/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f70756c6c732f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963) [![docker build open issues](https://camo.githubusercontent.com/17c4b2572d71a5f6d047e3442c8c7df5c02cde99380b96019e5a0623ee2c9f36/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f636f6d70757465726f6e69782f646f636b65722d7a796230743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/17c4b2572d71a5f6d047e3442c8c7df5c02cde99380b96019e5a0623ee2c9f36/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f636f6d70757465726f6e69782f646f636b65722d7a796230743f7374796c653d706c6173746963) [![docker build stars](https://camo.githubusercontent.com/e6b74f8cf29a0fb290579bfbbf4f7afa50bfcdb723792b2b165cd56e61ab15ec/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f73746172732f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/e6b74f8cf29a0fb290579bfbbf4f7afa50bfcdb723792b2b165cd56e61ab15ec/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f73746172732f636f6d70757465726f6e69782f7a796230743f7374796c653d706c6173746963) ### Stable Release [![docker build version by latest stable version](https://camo.githubusercontent.com/aa83f97f22b3a44eb722fa393a2bbb684f5c783263e462461fd84d4676c41640/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f7a796230742f6c61746573743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/aa83f97f22b3a44eb722fa393a2bbb684f5c783263e462461fd84d4676c41640/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f7a796230742f6c61746573743f7374796c653d706c6173746963) [![docker build size by latest stable version](https://camo.githubusercontent.com/cdfa94dd11d39f390a6d7d33531e440615b2e2d22d8543436b8e7dbad4443223/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f7a796230742f6c61746573743f7374796c653d706c6173746963)](https://camo.githubusercontent.com/cdfa94dd11d39f390a6d7d33531e440615b2e2d22d8543436b8e7dbad4443223/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f7a796230742f6c61746573743f7374796c653d706c6173746963) ### Beta Release [![docker build version by latest beta version](https://camo.githubusercontent.com/625cb4d119b01e263c9b188bab24469efdaeb6901ee0d1d49a9881306010c432/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f7a796230742f626574613f7374796c653d706c6173746963)](https://camo.githubusercontent.com/625cb4d119b01e263c9b188bab24469efdaeb6901ee0d1d49a9881306010c432/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f636f6d70757465726f6e69782f7a796230742f626574613f7374796c653d706c6173746963) [![docker build size by latest beta version](https://camo.githubusercontent.com/1589c824779acf1bed07826e04bdf63e0c212ea883fe10b0c3f320fcdfc2d850/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f7a796230742f626574613f7374796c653d706c6173746963)](https://camo.githubusercontent.com/1589c824779acf1bed07826e04bdf63e0c212ea883fe10b0c3f320fcdfc2d850/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f636f6d70757465726f6e69782f7a796230742f626574613f7374796c653d706c6173746963) # Support Troubleshooting / Feedback / Issues ## Need Help with Gunbot? Check out the Gunbot Wiki to [Learn how to use Gunbot | Gunbot docs (gunthy.org)](https://wiki.gunthy.org/) {% hint style="info" %} NOTE Gunbot Docker (Container) works the same as if it is running on Linux directly {% endhint %} ## Need Help or Have Feedback with Gunbot Docker * Join the Telegram Community, ask the Gunbot School for access. * Submit issues/feedback/feature requests at the GitHub site, under [issues](https://github.com/computeronix/docker-gunbot/issues).