Skip to content

Commit

Permalink
shadowmire: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
taoky committed Aug 10, 2024
1 parent f4faa04 commit f7f3800
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,8 @@ rustup-install.sh https://sh.rustup.rs/
[![pypi](https://img.shields.io/docker/image-size/ustcmirror/pypi/latest)](https://hub.docker.com/r/ustcmirror/pypi "pypi")
[![pypi](https://img.shields.io/docker/pulls/ustcmirror/pypi)](https://hub.docker.com/r/ustcmirror/pypi "pypi")

Sync PyPI with official mirror client [bandersnatch](https://github.com/pypa/bandersnatch). Note that this image is not actively maintained. It's suggested to use [shadowmire](#shadowmire) instead.

| Parameter | Description |
| ---------------------------- | ------------------- |
| `BANDERSNATCH_WORKERS` | Defaults to `3`. |
Expand Down Expand Up @@ -411,6 +413,20 @@ ref:
| ---------- | ---------------------------------- |
| `UPSTREAM` | Defaults to `http://rubygems.org`. |

### shadowmire

[![shadowmire](https://img.shields.io/docker/image-size/ustcmirror/shadowmire/latest)](https://hub.docker.com/r/ustcmirror/shadowmire "shadowmire")
[![shadowmire](https://img.shields.io/docker/pulls/ustcmirror/shadowmire)](https://hub.docker.com/r/ustcmirror/shadowmire "shadowmire")

[Shadowmire](https://github.com/taoky/shadowmire/) syncs PyPI (or plain HTTP(S) PyPI mirrors using Shadowmire) with a lightweight and easy approach.

| Parameter | Description |
| ---------------------------- | ------------------- |
| `UPSTREAM` | Defaults to `https://pypi.org`. |
| `INDEX_ONLY` | Don't download package blobs. Defaults to `false`. |
| `EXCLUDE` | A list of `--exclude` and `--prerelease-exclude`. |
| `USE_PYPI_INDEX` | Still use PyPI package listing when `UPSTREAM` is not `https://pypi.org`. Defaults to `false`. |

### stackage

[![stackage](https://img.shields.io/docker/image-size/ustcmirror/stackage/latest)](https://hub.docker.com/r/ustcmirror/stackage "stackage")
Expand Down

0 comments on commit f7f3800

Please sign in to comment.