mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: add custom dir placeholder explainer to installation guide (#22491)

Browse source 
* docs: add custom dir placeholder explainer to installation docs

* docs: provide a more concrete example of using ELECTRON_CUSTOM_DIR
This commit is contained in:
Mark Lee 2020-03-04 05:44:04 -08:00 • committed by GitHub
parent 2563681583
commit b4658efae5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/tutorial/installation.md
View file

@ -56,19 +56,33 @@ can do so by either providing a mirror or an existing cache directory.
#### Mirror #### Mirror
You can use environment variables to override the base URL, the path at which to You can use environment variables to override the base URL, the path at which to
look for Electron binaries, and the binary filename. The url used by `@electron/get` look for Electron binaries, and the binary filename. The URL used by `@electron/get`
is composed as follows: is composed as follows:
```plaintext ```javascript
url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME
``` ```
For instance, to use the China mirror: For instance, to use the China CDN mirror:
```plaintext ```shell
ELECTRON_MIRROR="https://cdn.npm.taobao.org/dist/electron/" ELECTRON_MIRROR="https://cdn.npm.taobao.org/dist/electron/"
``` ```
By default, `ELECTRON_CUSTOM_DIR` is set to `v$VERSION`. To change the format,
use the `{{ version }}` placeholder. For example, `version-{{ version }}`
resolves to `version-5.0.0`, `{{ version }}` resolves to `5.0.0`, and
`v{{ version }}` is equivalent to the default. As a more concrete example, to
use the China non-CDN mirror:
```shell
ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/"
ELECTRON_CUSTOM_DIR="{{ version }}"
```
The above configuration will download from URLs such as
`https://npm.taobao.org/mirrors/electron/8.0.0/electron-v8.0.0-linux-x64.zip`.
#### Cache #### Cache
Alternatively, you can override the local cache. `@electron/get` will cache Alternatively, you can override the local cache. `@electron/get` will cache
downloaded binaries in a local directory to not stress your network. You can use downloaded binaries in a local directory to not stress your network. You can use