tomjrtsmith / freqstart

Freqstart simplifies the use of Freqtrade with Docker.

FREQSTART v1.0.2

v1.0.2

• Changed folder "/data" to "/proxy" to avoid confusions with "/user_data" (Rename existing folder and re-run FreqUI setup)
• Improved freqtrade setup routine to utilize project function
• Improved project validate functions to ignore lines starting with comments (ignored: #example; not ignored: example #comment)
• Added check for empty files in strategy function
• Raised auto-update from 4 to every 6 hours
• Adopted user function and moved add group docker to prerequisites routine
• FreqUI proxy json and exchange proxy json files have been renamed (Review project files to match new filenames, see example below)
• Fixed error creating ssl key with openssl in Nginx IP routine (Thanks: lsiem)
• Fixed false container port bindings check in combination FreqUI json
• Added interactive start of container in compose routine for projects function

Setup & Docker-Manager for Freqtrade

Freqstart simplifies the use of Freqtrade with Docker. Including a simple setup guide for Freqtrade, configurations and FreqUI with a secured SSL proxy for IP or domain. Freqstart also automatically installs implemented strategies based on Docker Compose files and detects necessary updates.

If you are not familiar with Freqtrade, please read the complete documentation first on: www.freqtrade.io

Features

• Freqtrade Guided setup for Docker including the native config generator and creation of "user_data" folder.
• Docker Version check of images via manifest using minimal ressources and creating local backups.
• Prerequisites Install server prerequisites and upgrades and check for timezone sync (UTC).
• FreqUI Full setup of FreqUI with Nginx proxy for secured IP (openssl), domain (letsencrypt) or localhost.
• Binance Proxy Setup for Binance proxy if you run multiple bots at once incl. reusable config file.
• Kucoin Proxy Setup for Kucoin proxy if you run multiple bots at once incl. reusable config file.
• Strategies Automated installation of implemented strategies like NostalgiaForInfinity incl. updates.

Strategies

The following list is in alphabetical order and does not represent any recommendation:

• DoesNothingStrategy (Author: Gert Wohlgemuth, https://github.com/freqtrade/freqtrade-strategies)
• MultiMA_TSL (Author: stash86, https://github.com/stash86/MultiMA_TSL/)
• NostalgiaForInfinityX (Author: iterativ, https://github.com/iterativv/NostalgiaForInfinity)

Help expanding the strategies list and include config files if possible: freqstart.strategies.json

(back to top)

Getting Started

Freqstart provides an interactive setup guide for server security, Freqtrade incl. config creation, FreqUI, Binance- & Kucoin-Proxy routines.

Prerequisites

Freqstart installs server packages and configurations tailored to the needs of Freqtrade and may overwrite existing installations and configurations. It is recommended to set it up in a new and clean environment!

Packages: git, curl, jq, docker-ce, chrony, ufw

Recommended VPS

Vultr (AMD High Performance / Tokyo): www.vultr.com

Installation

1. Clone the repo

   git clone https://github.com/berndhofer/freqstart.git

2. Change directory to freqstart

   cd ~/freqstart

3. Make freqstart.sh executable

   sudo chmod +x freqstart.sh

4. Setup freqstart

   ./freqstart.sh --setup

5. Setup freqstart, non-interactive

   ./freqstart.sh --setup --yes

Start

1. Start a Freqtrade container

   freqstart --compose example.yml

2. Start a Freqtrade container, non-interactive

   freqstart --compose example.yml --yes

Stop

1. Stop a Freqtrade container and disable autoupdate

   freqstart --quit example.yml

2. Stop a Freqtrade container and disable autoupdate, non-interactive

   freqstart --quit example.yml --yes

Reset to stop and remove all docker images, containers and networks

freqstart --reset

(back to top)

Pojects

With Freqstart you are no longer bound to a single docker-compose.yml and can freely structure and link your Freqtrade bots.

• Have multiple container (services) in one project file
• Have a single container (service) in multiple project files
• Have multiple container (services) in multiple project files

Example Project (example.yml)

• Project file based on NostalgiaForInfinityX and Binance (BUSD) with Proxy and FreqUI enabled.

  version: '3'
  services:
    example_dryrun: # IMPORTANT: Dont forget to change service name!
      image: freqtradeorg/freqtrade:stable
      volumes:
        - "./user_data:/freqtrade/user_data"
      ports:
        - "127.0.0.1:9000:9999" # OPTIONAL: Choose port between 9000 and 9100 and forward to 9999 or remove if not using FreqUI.
      tty: true
      command: >
        trade
        --dry-run
        --dry-run-wallet
        --db-url sqlite:////freqtrade/user_data/example_dryrun.sqlite
        --logfile /freqtrade/user_data/logs/example_dryrun.log
        --strategy NostalgiaForInfinityX
        --strategy-path /freqtrade/user_data/strategies/NostalgiaForInfinityX
        --config /freqtrade/user_data/strategies/NostalgiaForInfinityX/exampleconfig.json
        --config /freqtrade/user_data/strategies/NostalgiaForInfinityX/pairlist-volume-binance-busd.json
        --config /freqtrade/user_data/strategies/NostalgiaForInfinityX/blacklist-binance.json
        --config /freqtrade/user_data/freqstart_frequi.json # OPTIONAL: If you want to manage bot via FreqUI.
        --config /freqtrade/user_data/freqstart_proxy_binance.json

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Disclaimer

This software is for educational purposes only. 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.

(back to top)

Support

Since this is a small project where I taught myself some bash scripts, you are welcome to improve the code. If you just use the script and like it, remember that it took a lot of time, testing and also money for infrastructure. You can contribute by donating to the following wallets. Thank you very much for that!

• BTC 1M6wztPA9caJbSrLxa6ET2bDJQdvigZ9hZ
• ETH 0xb155f0F64F613Cd19Fb35d07D43017F595851Af5
• BSC 0xb155f0F64F613Cd19Fb35d07D43017F595851Af5

(back to top)