Document use of the file:// scheme in Python installation mirrors

astral-sh · Sep 3, 2024 · bb46409 · bb46409
1 parent 4a6bea5
commit bb46409
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/configuration/environment.md b/docs/configuration/environment.md
@@ -83,11 +83,13 @@ In addition, uv respects the following environment variables:
   can be set to a mirror URL to use a different source for Python installations. The provided URL
   will replace `https://github.com/indygreg/python-build-standalone/releases/download` in, e.g.,
   `https://github.com/indygreg/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.
+  Distributions can be read from a local directory by using the `file://` URL scheme.
 - `UV_PYPY_INSTALL_MIRROR`: Managed PyPy installations are downloaded from
   [python.org](https://downloads.python.org/). This variable can be set to a mirror URL to use a
   different source for PyPy installations. The provided URL will replace
   `https://downloads.python.org/pypy` in, e.g.,
   `https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.
+  Distributions can be read from a local directory by using the `file://` URL scheme.
 - `XDG_CONFIG_HOME`: Used to specify the path to uv user-level configuration directory on Unix
   systems.
 - `XDG_CACHE_HOME`: Used to specify the directory where uv stores cache files on Unix systems.