CTYPTO/freqtrade
1
0
Fork 0
mirror of https://github.com/freqtrade/freqtrade.git synced 2026-02-15 18:50:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 00848c9 to develop in en with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2026-01-25 09:11:38 +00:00
parent 730da0e391
commit 43845bb618
51 changed files with 187 additions and 6213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

241
en/develop/installation/index.html
View File

@@ -16,7 +16,7 @@
<link rel="prev" href="../docker_quickstart/">
<link rel="next" href="../windows_installation/">
<link rel="next" href="../bot-basics/">
@@ -27,7 +27,7 @@
<title>Linux/MacOS/Raspberry - Freqtrade</title>
<title>Installation - Freqtrade</title>
@@ -129,7 +129,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Linux/MacOS/Raspberry
Installation
</span>
</div>
@@ -336,55 +336,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
@@ -400,7 +351,7 @@
<span class="md-ellipsis">
Linux/MacOS/Raspberry
Installation
@@ -418,7 +369,7 @@
<span class="md-ellipsis">
Linux/MacOS/Raspberry
Installation
@@ -553,6 +504,18 @@
</span>
</a>
<nav class="md-nav" aria-label="Use /setup.sh -install (Linux/MacOS)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#other-options-of-setupsh-script" class="md-nav__link">
<span class="md-ellipsis">
Other options of /setup.sh script
</span>
</a>
</li>
<li class="md-nav__item">
@@ -564,17 +527,39 @@
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#other-options-of-setupsh-script" class="md-nav__link">
<a href="#use-setupps1-windows" class="md-nav__link">
<span class="md-ellipsis">
Other options of /setup.sh script
Use ./setup.ps1 (Windows)
</span>
</a>
<nav class="md-nav" aria-label="Use ./setup.ps1 (Windows)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#activate-your-virtual-environment-windows" class="md-nav__link">
<span class="md-ellipsis">
Activate your virtual environment (Windows)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -814,6 +799,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#windows-installation-error" class="md-nav__link">
<span class="md-ellipsis">
Windows Installation error
</span>
</a>
</li>
</ul>
@@ -828,42 +824,6 @@
</li>
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<span class="md-ellipsis">
Windows
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -2403,6 +2363,18 @@
</span>
</a>
<nav class="md-nav" aria-label="Use /setup.sh -install (Linux/MacOS)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#other-options-of-setupsh-script" class="md-nav__link">
<span class="md-ellipsis">
Other options of /setup.sh script
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2414,17 +2386,39 @@
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#other-options-of-setupsh-script" class="md-nav__link">
<a href="#use-setupps1-windows" class="md-nav__link">
<span class="md-ellipsis">
Other options of /setup.sh script
Use ./setup.ps1 (Windows)
</span>
</a>
<nav class="md-nav" aria-label="Use ./setup.ps1 (Windows)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#activate-your-virtual-environment-windows" class="md-nav__link">
<span class="md-ellipsis">
Activate your virtual environment (Windows)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -2664,6 +2658,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#windows-installation-error" class="md-nav__link">
<span class="md-ellipsis">
Windows Installation error
</span>
</a>
</li>
</ul>
@@ -2705,16 +2710,22 @@
<li><a href="#manual-installation">Manual Installation</a></li>
<li><a href="#installation-with-conda">Installation with Conda</a></li>
</ul>
<p>Please consider using the prebuilt <a href="../docker_quickstart/">docker images</a> to get started quickly while evaluating how freqtrade works.</p>
<p>Please consider using the prebuilt <a href="../docker_quickstart/">docker images</a> to get started quickly.</p>
<div class="admonition note">
<p class="admonition-title">Updating</p>
<p>Keeping freqtrade updated is important to <a href="../updating/#why-update">ensure ongoing compatibility</a> with exchange API's.
Please refer to the <a href="../updating/">updating guide</a> for details on how to update your installation.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Windows users</p>
<p>We <strong>strongly</strong> recommend that Windows users use <a href="../docker_quickstart/">Docker</a> as this will work much easier and smoother (also more secure).</p>
<p>If that is not possible, try using the Windows Linux subsystem (WSL) - for which the Ubuntu/Linux instructions will work.
If you really want to install freqtrade natively on Windows, best use the <a href="#use-setupps1-windows"><code>./setup.ps1</code> installation script</a>.</p>
<p>Please also make sure to use the 64bit version of Python, as 32bit versions have severe memory limitations, which can negatively impact your experience with backtesting/hyperopt.</p>
</div>
<hr />
<h2 id="information">Information<a class="headerlink" href="#information" title="Permanent link">&para;</a></h2>
<p>For Windows installation, please use the <a href="../windows_installation/">windows installation guide</a>.</p>
<p>The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the <code>./setup.sh</code> script, if it's available for your platform.</p>
<p>The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the <code>./setup.sh</code> (<code>./setup.ps1</code> for Windows) script, if it's available for your platform.</p>
<div class="admonition note">
<p class="admonition-title">Version considerations</p>
<p>When cloning the repository the default working branch has the name <code>develop</code>. This branch contains all last features (can be considered as relatively stable, thanks to automated tests).
@@ -2831,14 +2842,8 @@ git<span class="w"> </span>checkout<span class="w"> </span>develop
<div class="highlight"><pre><span></span><code><span class="c1"># --install, Install freqtrade from scratch</span>
./setup.sh<span class="w"> </span>-i
</code></pre></div>
<h3 id="activate-your-virtual-environment">Activate your virtual environment<a class="headerlink" href="#activate-your-virtual-environment" title="Permanent link">&para;</a></h3>
<p>Each time you open a new terminal, you must run <code>source .venv/bin/activate</code> to activate your virtual environment.</p>
<div class="highlight"><pre><span></span><code><span class="c1"># activate virtual environment</span>
<span class="nb">source</span><span class="w"> </span>./.venv/bin/activate
</code></pre></div>
<p><a href="#you-are-ready">You are now ready</a> to run the bot.</p>
<h3 id="other-options-of-setupsh-script">Other options of /setup.sh script<a class="headerlink" href="#other-options-of-setupsh-script" title="Permanent link">&para;</a></h3>
<p>You can as well update, configure and reset the codebase of your bot with <code>./script.sh</code></p>
<h4 id="other-options-of-setupsh-script">Other options of /setup.sh script<a class="headerlink" href="#other-options-of-setupsh-script" title="Permanent link">&para;</a></h4>
<p>You can also update, configure and reset the codebase of your bot with <code>./setup.sh</code></p>
<div class="highlight"><pre><span></span><code><span class="c1"># --update, Command git pull to update.</span>
./setup.sh<span class="w"> </span>-u
<span class="c1"># --reset, Hard reset your develop/stable branch.</span>
@@ -2862,6 +2867,22 @@ This option will pull the last version of your current branch and update your vi
This option will hard reset your branch (only if you are on either `stable` or `develop`) and recreate your virtualenv.
</code></pre></div>
<h4 id="activate-your-virtual-environment">Activate your virtual environment<a class="headerlink" href="#activate-your-virtual-environment" title="Permanent link">&para;</a></h4>
<p>Each time you open a new terminal, you must run <code>source .venv/bin/activate</code> to activate your virtual environment.</p>
<div class="highlight"><pre><span></span><code><span class="c1"># activate virtual environment</span>
<span class="nb">source</span><span class="w"> </span>./.venv/bin/activate
</code></pre></div>
<h3 id="use-setupps1-windows">Use ./setup.ps1 (Windows)<a class="headerlink" href="#use-setupps1-windows" title="Permanent link">&para;</a></h3>
<p>The script will ask you a few questions to determine which parts should be installed.</p>
<div class="highlight"><pre><span></span><code><span class="nb">Set-ExecutionPolicy</span> <span class="n">-ExecutionPolicy</span> <span class="n">Bypass</span>
<span class="nb">cd </span><span class="n">freqtrade</span>
<span class="p">.</span> <span class="p">.\</span><span class="n">setup</span><span class="p">.</span><span class="n">ps1</span>
</code></pre></div>
<h4 id="activate-your-virtual-environment-windows">Activate your virtual environment (Windows)<a class="headerlink" href="#activate-your-virtual-environment-windows" title="Permanent link">&para;</a></h4>
<div class="highlight"><pre><span></span><code><span class="c"># activate virtual environment</span>
<span class="p">.</span> <span class="p">.\.</span><span class="n">venv</span><span class="p">\</span><span class="n">Scripts</span><span class="p">\</span><span class="n">Activate</span><span class="p">.</span><span class="n">ps1</span>
</code></pre></div>
<p><a href="#you-are-ready">You are now ready</a> to run the bot.</p>
<hr />
<h2 id="manual-installation">Manual Installation<a class="headerlink" href="#manual-installation" title="Permanent link">&para;</a></h2>
<p>Make sure you fulfill the <a href="#requirements">Requirements</a> and have downloaded the <a href="#freqtrade-repository">Freqtrade repository</a>.</p>
@@ -2997,6 +3018,12 @@ For MacOS 10.14, this can be accomplished with the below command.</p>
<div class="highlight"><pre><span></span><code>open<span class="w"> </span>/Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
</code></pre></div>
<p>If this file is inexistent, then you're probably on a different version of MacOS, so you may need to consult the internet for specific resolution details.</p>
<h3 id="windows-installation-error">Windows Installation error<a class="headerlink" href="#windows-installation-error" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>error:<span class="w"> </span>Microsoft<span class="w"> </span>Visual<span class="w"> </span>C++<span class="w"> </span><span class="m">14</span>.0<span class="w"> </span>is<span class="w"> </span>required.<span class="w"> </span>Get<span class="w"> </span>it<span class="w"> </span>with<span class="w"> </span><span class="s2">&quot;Microsoft Visual C++ Build Tools&quot;</span>:<span class="w"> </span>http://landinghub.visualstudio.com/visual-cpp-build-tools
</code></pre></div>
<p>Unfortunately, many packages requiring compilation don't provide a pre-built wheel. It is therefore mandatory to have a C/C++ compiler installed and available for your python environment to use.</p>
<p>You can download the Visual C++ build tools from <a href="https://visualstudio.microsoft.com/visual-cpp-build-tools/">here</a> and install "Desktop development with C++" in it's default configuration. Unfortunately, this is a heavy download / dependency so you might want to consider WSL2 or <a href="../docker_quickstart/">docker compose</a> first.</p>
<p><img alt="Windows installation" src="../assets/windows_install.png" /></p>
@@ -3052,13 +3079,13 @@ For MacOS 10.14, this can be accomplished with the below command.</p>
<a href="../windows_installation/" class="md-footer__link md-footer__link--next" aria-label="Next: Windows">
<a href="../bot-basics/" class="md-footer__link md-footer__link--next" aria-label="Next: Freqtrade Basics">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Windows
Freqtrade Basics
</div>
</div>
<div class="md-footer__button md-icon">