Skip to content

Commit fa63a00

Browse files
Document Pkg and NetworkOptions environment variables (JuliaLang#43215)
I added these to the Julia docs instead of Pkg.jl so that they would all be in one place. Fixes JuliaLang/Pkg.jl#2453 Co-authored-by: Elliot Saba <staticfloat@gmail.com>
1 parent 543971f commit fa63a00

File tree

1 file changed

+80
-6
lines changed

1 file changed

+80
-6
lines changed

doc/src/manual/environment-variables.md

Lines changed: 80 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,14 +156,88 @@ The absolute path `REPL.find_hist_file()` of the REPL's history file. If
156156
$(DEPOT_PATH[1])/logs/repl_history.jl
157157
```
158158

159+
### `JULIA_MAX_NUM_PRECOMPILE_FILES`
160+
161+
Sets the maximum number of different instances of a single package that are to be stored in the precompile cache (default = 10).
162+
163+
## Pkg.jl
164+
165+
### `JULIA_CI`
166+
167+
If set to `true`, this indicates to the package server that any package operations are part of a continuous integration (CI) system for the purposes of gathering package usage statistics.
168+
169+
### `JULIA_NUM_PRECOMPILE_TASKS`
170+
171+
The number of parallel tasks to use when precompiling packages. See [`Pkg.precompile`](https://pkgdocs.julialang.org/v1/api/#Pkg.precompile).
172+
173+
### `JULIA_PKG_DEVDIR`
174+
175+
The default directory used by [`Pkg.develop`](https://pkgdocs.julialang.org/v1/api/#Pkg.develop) for downloading packages.
176+
177+
### `JULIA_PKG_IGNORE_HASHES`
178+
179+
If set to `1`, this will ignore incorrect hashes in artifacts. This should be used carefully, as it disables verification of downloads, but can resolve issues when moving files across different types of file systems. See [Pkg.jl issue #2317](https://github.com/JuliaLang/Pkg.jl/issues/2317) for more details.
180+
181+
!!! compat "Julia 1.6"
182+
This is only supported in Julia 1.6 and above.
183+
184+
### `JULIA_PKG_OFFLINE`
185+
186+
If set to `true`, this will enable offline mode: see [`Pkg.offline`](https://pkgdocs.julialang.org/v1/api/#Pkg.offline).
187+
188+
!!! compat "Julia 1.5"
189+
Pkg's offline mode requires Julia 1.5 or later.
190+
191+
### `JULIA_PKG_PRECOMPILE_AUTO`
192+
193+
If set to `0`, this will disable automatic precompilation by package actions which change the manifest. See [`Pkg.precompile`](https://pkgdocs.julialang.org/v1/api/#Pkg.precompile).
194+
159195
### `JULIA_PKG_SERVER`
160196

161-
Used by `Pkg.jl`, for downloading packages and updating the registry. By default, `Pkg` uses `https://pkg.julialang.org` to
162-
fetch Julia packages. You can use this environment variable to select a different server. In addition, you can disable the use of the
163-
PkgServer protocol, and instead access the packages directly from their hosts (GitHub, GitLab, etc.) by setting:
164-
```
165-
export JULIA_PKG_SERVER=""
166-
```
197+
Specifies the URL of the package registry to use. By default, `Pkg` uses
198+
`https://pkg.julialang.org` to fetch Julia packages. In addition, you can disable the use of the PkgServer
199+
protocol, and instead access the packages directly from their hosts (GitHub, GitLab, etc.)
200+
by setting: ``` export JULIA_PKG_SERVER="" ```
201+
202+
### `JULIA_PKG_SERVER_REGISTRY_PREFERENCE`
203+
204+
Specifies the preferred registry flavor. Currently supported values are `conservative`
205+
(the default), which will only publish resources that have been processed by the storage
206+
server (and thereby have a higher probability of being available from the PkgServers),
207+
whereas `eager` will publish registries whose resources have not necessarily been
208+
processed by the storage servers. Users behind restrictive firewalls that do not allow
209+
downloading from arbitrary servers should not use the `eager` flavor.
210+
211+
!!! compat "Julia 1.7"
212+
This only affects Julia 1.7 and above.
213+
214+
### `JULIA_PKG_UNPACK_REGISTRY`
215+
216+
If set to `true`, this will unpack the registry instead of storing it as a compressed tarball.
217+
218+
!!! compat "Julia 1.7"
219+
This only affects Julia 1.7 and above. Earlier versions will always unpack the registry.
220+
221+
### `JULIA_PKG_USE_CLI_GIT`
222+
223+
If set to `true`, Pkg operations which use the git protocol will use an external `git` executable instead of the default libgit2 library.
224+
225+
!!! compat "Julia 1.7"
226+
Use of the `git` executable is only supported on Julia 1.7 and above.
227+
228+
### `JULIA_PKGRESOLVE_ACCURACY`
229+
230+
The accuracy of the package resolver. This should be a positive integer, the default is `1`.
231+
232+
## Network transport
233+
234+
### `JULIA_NO_VERIFY_HOSTS` / `JULIA_SSL_NO_VERIFY_HOSTS` / `JULIA_SSH_NO_VERIFY_HOSTS` / `JULIA_ALWAYS_VERIFY_HOSTS`
235+
236+
Specify hosts whose identity should or should not be verified for specific transport layers. See [`NetworkOptions.verify_host`](https://github.com/JuliaLang/NetworkOptions.jl#verify_host)
237+
238+
### `JULIA_SSL_CA_ROOTS_PATH`
239+
240+
Specify the file or directory containing the certificate authority roots. See [`NetworkOptions.ca_roots`](https://github.com/JuliaLang/NetworkOptions.jl#ca_roots)
167241

168242
## External applications
169243

0 commit comments

Comments
 (0)