alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

feat(tools): Add dl.espressif.cn IDF_GITHUB_ASSET to documentation

Browse Source
This commit is contained in:
Marek Fiala 2023-08-28 16:30:55 +02:00 committed by BOT
parent cebaec6480
commit 608b6e5480
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-guides/tools/idf-tools.rst
View File

@ -52,7 +52,7 @@ Most of the tools downloaded by the tools installer are GitHub Release Assets, w
If GitHub downloads are inaccessible or slow to access, a GitHub assets mirror can be configured. If GitHub downloads are inaccessible or slow to access, a GitHub assets mirror can be configured.
To use Espressif's download server, set the environment variable ``IDF_GITHUB_ASSETS`` to ``dl.espressif.com/github_assets``. When the install process is downloading a tool from ``github.com``, the URL will be rewritten to use this server instead. To use Espressif's download server, set the environment variable ``IDF_GITHUB_ASSETS`` to ``dl.espressif.com/github_assets``, or ``dl.espressif.cn/github_assets`` for faster download in China. When the install process is downloading a tool from ``github.com``, the URL will be rewritten to use this server instead.
Any mirror server can be used provided the URL matches the ``github.com`` download URL format. For any GitHub asset URL that the install process downloads, it will replace ``https://github.com`` with ``https://${IDF_GITHUB_ASSETS}``. Any mirror server can be used provided the URL matches the ``github.com`` download URL format. For any GitHub asset URL that the install process downloads, it will replace ``https://github.com`` with ``https://${IDF_GITHUB_ASSETS}``.

9
docs/en/get-started/linux-macos-setup.rst
View File

@ -204,6 +204,15 @@ To prefer the Espressif download server when installing tools, use the following
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets" export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
./install.sh ./install.sh
.. note::
For users in China, we recommend using our download server located in China for faster download speed.
.. code-block:: bash
cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.cn/github_assets"
./install.sh
Customizing the Tools Installation Path Customizing the Tools Installation Path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~