Merge branch 'qcoudeyr-app/octobot'
This commit is contained in:
Nicolas Meienberger
commit
980372c9df
16
apps/octobot/config.json
Normal file
16
apps/octobot/config.json
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"name": "Octobot",
|
||||
"port": 8825,
|
||||
"available": true,
|
||||
"exposable": true,
|
||||
"id": "octobot",
|
||||
"tipi_version": 1,
|
||||
"version": "1.0.3",
|
||||
"categories": ["automation", "finance"],
|
||||
"description": "OctoBot is a highly customizable trading bot using its configuration and tentacles system. You can build your own bot using the infinite configuration possibilities such as technical analysis, social media processing or even external statistics management like google trends.",
|
||||
"short_desc": "Octobot is a powerful open-source cryptocurrency trading robot.",
|
||||
"author": "https://github.com/Drakkar-Software/",
|
||||
"source": "https://github.com/Drakkar-Software/OctoBot",
|
||||
"form_fields": [],
|
||||
"supported_architectures": ["arm64", "amd64"]
|
||||
}
|
||||
43
apps/octobot/docker-compose.yml
Normal file
43
apps/octobot/docker-compose.yml
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
version: '3.9'
|
||||
services:
|
||||
octobot:
|
||||
container_name: octobot
|
||||
image: drakkarsoftware/octobot:1.0.3
|
||||
environment:
|
||||
- TZ=${TZ}
|
||||
volumes:
|
||||
- ${APP_DATA_DIR}/data/user:/octobot/user
|
||||
- ${APP_DATA_DIR}/data/tentacles:/octobot/tentacles
|
||||
- ${APP_DATA_DIR}/data/logs:/octobot/logs
|
||||
ports:
|
||||
- ${APP_PORT}:5001
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- tipi_main_network
|
||||
dns:
|
||||
- ${DNS_IP}
|
||||
labels:
|
||||
# Main
|
||||
traefik.enable: true
|
||||
traefik.http.middlewares.octobot-web-redirect.redirectscheme.scheme: https
|
||||
traefik.http.services.octobot.loadbalancer.server.port: 5001
|
||||
# Web
|
||||
traefik.http.routers.octobot-insecure.rule: Host(`${APP_DOMAIN}`)
|
||||
traefik.http.routers.octobot-insecure.entrypoints: web
|
||||
traefik.http.routers.octobot-insecure.service: octobot
|
||||
traefik.http.routers.octobot-insecure.middlewares: octobot-web-redirect
|
||||
# Websecure
|
||||
traefik.http.routers.octobot.rule: Host(`${APP_DOMAIN}`)
|
||||
traefik.http.routers.octobot.entrypoints: websecure
|
||||
traefik.http.routers.octobot.service: octobot
|
||||
traefik.http.routers.octobot.tls.certresolver: myresolver
|
||||
# Local domain
|
||||
traefik.http.routers.octobot-local-insecure.rule: Host(`octobot.${LOCAL_DOMAIN}`)
|
||||
traefik.http.routers.octobot-local-insecure.entrypoints: web
|
||||
traefik.http.routers.octobot-local-insecure.service: octobot
|
||||
traefik.http.routers.octobot-local-insecure.middlewares: octobot-web-redirect
|
||||
# Local domain secure
|
||||
traefik.http.routers.octobot-local.rule: Host(`octobot.${LOCAL_DOMAIN}`)
|
||||
traefik.http.routers.octobot-local.entrypoints: websecure
|
||||
traefik.http.routers.octobot-local.service: octobot
|
||||
traefik.http.routers.octobot-local.tls: true
|
||||
100
apps/octobot/metadata/description.md
Normal file
100
apps/octobot/metadata/description.md
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
## What is Octobot ?
|
||||
|
||||
<p align="middle">
|
||||
<a href="https://www.octobot.cloud/guides/octobot-interfaces/web?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=readme_what_is_octobot_web">
|
||||
<img src="https://github.com/Drakkar-Software/OctoBot/raw/assets/dashboard.png" height="414" alt="Follow your profits using OctoBot directly from its web interface">
|
||||
</a>
|
||||
|
||||
<a href="https://www.octobot.cloud/guides/octobot-interfaces/telegram?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=readme_what_is_octobot_telegram">
|
||||
<img src="https://github.com/Drakkar-Software/OctoBot/raw/assets/telegram-interface.png" height="414" alt="Follow each trade and profits of your OctoBot and send it commands from telegram">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[Octobot](https://www.octobot.cloud/?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=readme_what_is_octobot) is a powerful open-source cryptocurrency trading robot.
|
||||
|
||||
OctoBot is highly customizable using its configuration and tentacles system.
|
||||
You can build your own bot using the infinite [configuration](https://www.octobot.cloud/guides/octobot-configuration/profile-configuration?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=configuration) possibilities such as **technical analysis**, **social media processing** or even **external statistics management** like google trends.
|
||||
|
||||
OctoBot is **AI ready**: Python being the main language for OctoBot, it's easy to integrate machine-learning libraries such as [Tensorflow](https://github.com/tensorflow/tensorflow) or any other libraries and take advantage of all the available data and create a very powerful trading strategy.
|
||||
|
||||
Octobot's main feature is **evolution**, you can :
|
||||
|
||||
- Share your configurations with other octobot users.
|
||||
- [Install](https://www.octobot.cloud/guides/octobot-advanced-usage/tentacle-manager?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=install_tentacles), [modify](https://www.octobot.cloud/guides/octobot-tentacles-development/create-a-tentacle?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=modify_tentacles) and even [create](https://www.octobot.cloud/guides/octobot-tentacles-development/create-a-tentacle?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=create_tentacles) new tentacles to build your ideal cryptocurrency trading robot.
|
||||
- [Contribute](https://www.octobot.cloud/guides/octobot-developers-environment/setup-your-environment?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=contribute) to improve OctoBot core repositories and tentacles.
|
||||
|
||||
Looking for more info ? Check out our Octobot guides at [octobot.cloud/guides](https://www.octobot.cloud/guides/?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=checkout_guides)
|
||||
|
||||
## Exchanges
|
||||
|
||||
Octobot supports many [exchanges](https://www.octobot.cloud/guides/exchanges?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=exchanges) thanks to the [ccxt library](https://github.com/ccxt/ccxt).
|
||||
To activate trading on an exchange, just configure OctoBot with your API keys as described [on the exchange setup guides](https://www.octobot.cloud/guides/octobot-configuration/exchanges?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=exchanges_setup_guides).
|
||||
|
||||
## Certified Cryptocurrency Exchanges
|
||||
|
||||
| logo | id | name | ver | certified | pro | discount |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| [](https://accounts.binance.com/en/register?ref=D7YA7CLY) | binance | [Binance](https://accounts.binance.com/en/register?ref=D7YA7CLY) | [](https://binance-docs.github.io/apidocs/spot/en) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://accounts.binance.com/en/register?ref=D7YA7CLY) |
|
||||
| [](https://accounts.binance.com/en/register?ref=D7YA7CLY) | binancecoinm | [Binance COIN-M](https://accounts.binance.com/en/register?ref=D7YA7CLY) | [](https://binance-docs.github.io/apidocs/delivery/en/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://accounts.binance.com/en/register?ref=D7YA7CLY) |
|
||||
| [](https://accounts.binance.com/en/register?ref=D7YA7CLY) | binanceusdm | [Binance USDⓈ-M](https://accounts.binance.com/en/register?ref=D7YA7CLY) | [](https://binance-docs.github.io/apidocs/futures/en/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://accounts.binance.com/en/register?ref=D7YA7CLY) |
|
||||
| [](https://bingx.com/invite/OHETOM) | bingx | [BingX](https://bingx.com/invite/OHETOM) | [](https://bingx-api.github.io/docs/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://www.bitget.com/expressly?languageType=0&channelCode=ccxt&vipCode=tg9j) | bitget | [Bitget](https://www.bitget.com/expressly?languageType=0&channelCode=ccxt&vipCode=tg9j) | [](https://bitgetlimited.github.io/apidoc/en/mix) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](http://www.bitmart.com/?r=rQCFLh) | bitmart | [BitMart](http://www.bitmart.com/?r=rQCFLh) | [](https://developer-pro.bitmart.com/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](http://www.bitmart.com/?r=rQCFLh) |
|
||||
| [](https://www.bitmex.com/register/upZpOX) | bitmex | [BitMEX](https://www.bitmex.com/register/upZpOX) | [](https://www.bitmex.com/app/apiOverview) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://bitvavo.com/?a=24F34952F7) | bitvavo | [Bitvavo](https://bitvavo.com/?a=24F34952F7) | [](https://docs.bitvavo.com/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://www.bybit.com/register?affiliate_id=35953) | bybit | [Bybit](https://www.bybit.com/register?affiliate_id=35953) | [](https://bybit-exchange.github.io/docs/inverse/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://crypto.com/exch/5835vstech) | cryptocom | [Crypto.com](https://crypto.com/exch/5835vstech) | [](https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://www.gate.io/signup/2436035) | gate | [Gate.io](https://www.gate.io/signup/2436035) | [](https://www.gate.io/docs/developers/apiv4/en/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://www.gate.io/signup/2436035) |
|
||||
| [](https://www.huobi.com/en-us/v/register/double-invite/?inviter_id=11343840&invite_code=6rmm2223) | huobi | [Huobi](https://www.huobi.com/en-us/v/register/double-invite/?inviter_id=11343840&invite_code=6rmm2223) | [](https://huobiapi.github.io/docs/spot/v1/en/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://www.huobi.com/en-us/v/register/double-invite/?inviter_id=11343840&invite_code=6rmm2223) |
|
||||
| [](https://www.kucoin.com/ucenter/signup?rcode=E5wkqe) | kucoin | [KuCoin](https://www.kucoin.com/ucenter/signup?rcode=E5wkqe) | [](https://docs.kucoin.com) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://futures.kucoin.com/?rcode=E5wkqe) | kucoinfutures | [KuCoin Futures](https://futures.kucoin.com/?rcode=E5wkqe) | [](https://docs.kucoin.com/futures) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://m.mexc.com/auth/signup?inviteCode=1FQ1G) | mexc | [MEXC Global](https://m.mexc.com/auth/signup?inviteCode=1FQ1G) | [](https://mxcdevelop.github.io/apidocs/spot_v3_en/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | |
|
||||
| [](https://www.okx.com/activities/ccxt-trade-and-earn?channelid=CCXT2023) | okx | [OKX](https://www.okx.com/activities/ccxt-trade-and-earn?channelid=CCXT2023) | [](https://www.okx.com/docs-v5/en/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://www.okx.com/activities/ccxt-trade-and-earn?channelid=CCXT2023) |
|
||||
| [](https://wx.network) | wavesexchange | [Waves.Exchange](https://wx.network) | [](https://docs.wx.network) | [](https://github.com/ccxt/ccxt/wiki/Certification) | | |
|
||||
| [](https://x.woo.org/register?ref=YWOWC96B) | woo | [WOO X](https://x.woo.org/register?ref=YWOWC96B) | [](https://docs.woo.org/) | [](https://github.com/ccxt/ccxt/wiki/Certification) | [](https://ccxt.pro) | [](https://x.woo.org/register?ref=YWOWC96B) |
|
||||
|
||||
### Paper trading
|
||||
|
||||
To trade on any exchange, just enable the exchange in your OctoBot. This you to trade with simulated money on this exchange.
|
||||
|
||||
No exchange credential is required.
|
||||
|
||||
### Real trading
|
||||
|
||||
To use your real exchange account with OctoBot, enter your exchange API keys as described [on the exchange guides](https://www.octobot.cloud/guides/exchanges?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=exchanges_guides).
|
||||
|
||||
## Testing trading strategies
|
||||
|
||||
OctoBot comes with its builtin backtesting engine which enables you to trade with simulated money using historical exchange data.
|
||||
|
||||
[](https://github.com/Drakkar-Software/OctoBot/blob/assets/backtesting_report.jpg)
|
||||
|
||||
Backtesting will give you accurate insights on the past performance and behavior of strategies using OctoBot.
|
||||
|
||||
## Contribute from a browser IDE
|
||||
|
||||
Make changes and contribute to OctoBot in a single click with an **already setup and ready to code developer environment** using Gitpod !
|
||||
|
||||
[](https://gitpod.io/#https://github.com/Drakkar-Software/OctoBot)
|
||||
|
||||
## Hardware requirements
|
||||
|
||||
- CPU : 1 Core / 1GHz
|
||||
- RAM : 250 MB
|
||||
- Disk : 1 GB
|
||||
|
||||
## Disclaimer
|
||||
|
||||
Do not risk money which you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS
|
||||
AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
|
||||
|
||||
Always start by running a trading bot in simulation mode and do not engage money
|
||||
before you understand how it works and what profit/loss you should expect.
|
||||
|
||||
Please feel free to read the source code and understand the mechanism of this bot.
|
||||
|
||||
## License
|
||||
|
||||
GNU General Public License v3.0 or later.
|
||||
|
||||
See [GPL-3.0 LICENSE](https://octobot.click/gh-license) to see the full text.
|
||||
BIN
apps/octobot/metadata/logo.jpg
Normal file
BIN
apps/octobot/metadata/logo.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Loading…
Reference in New Issue
Block a user