Skip to content

Commit 2aaea3e

Browse files
committed
Update README with instructions on setting registry URL
1 parent da4bd63 commit 2aaea3e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,17 @@ You can set these environment variables to configure the server:
5656

5757
* `PYPI_BROWSER_PYPI_URL`: URL for the PyPI server to use (defaults to
5858
`https://pypi.org`)
59+
60+
If your registry supports the pypi.org-compatible JSON API (e.g.
61+
`{registry}/pypi/{package}/json`), specify your base registry URL without
62+
appending `/simple` (e.g. `https://my-registry`).
63+
64+
If your registry only supports the traditional HTML "simple" index, specify
65+
the registry URL with `/simple` at the end (e.g.
66+
`https://my-registry/simple`).
67+
68+
Note that the [PEP691][pep691] JSON-based "simple" API is not yet supported.
69+
5970
* `PYPI_BROWSER_PACKAGE_CACHE_PATH`: Filesystem path to use for caching
6071
downloaded files. This will grow forever (the app does not clean it up) so
6172
you may want to use `tmpreaper` or similar to manage its size.
@@ -77,3 +88,5 @@ $ make start-dev
7788
```
7889

7990
to run a copy of the application locally with hot reloading enabled.
91+
92+
[pep691]: https://peps.python.org/pep-0691/

0 commit comments

Comments
 (0)