From 37866ae72723976c856d646c09e9b165b10ccd6f Mon Sep 17 00:00:00 2001
From: Anonymous <>
Date: Sat, 6 Jul 2024 12:09:00 +0800
Subject: [PATCH] docs

---
 README.md              | 48 +++++++++++++++++++++++-------------------
 test/scripts/python.sh |  2 +-
 2 files changed, 27 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 1dcd5c3..62fb376 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,16 @@
 
 
 LightMirrors是一个开源的缓存镜像站服务，用于加速软件包下载和镜像拉取。
-目前支持**DockerHub**、**K8s**、**GitHub Container Registry**、**Quay.io**、PyPI、PyTorch、NPM等镜像缓存服务。 当前项目仍处于早期阶段。
+目前支持
+**DockerHub**、
+**K8s**、
+**GitHub Container Registry**、
+**Quay.io**、
+PyPI、
+PyTorch、
+NPM、
+GoProxy
+等镜像缓存服务。 当前项目仍处于早期阶段。
 
 欢迎提交Pull Request和Issue，我们非常期待您的宝贵建议和意见。
 
@@ -41,17 +50,20 @@ docker-compose up
 
 ```
 
-并尝试通过控制台输出的地址进行访问，http://aria2.local.homeinfra.org/aria2/index.html
+并尝试通过控制台输出的地址进行访问，https://aria2.local.homeinfra.org/aria2/index.html
 为aria2的管理界面，用于查看下载状态`。
 
 可以使用以下命令进行测试镜像站是否正常工作：
 
 ```bash
 docker pull docker.local.homeinfra.org/alpine
-pip3 download -i http://pypi.local.homeinfra.org/simple/ jinja2 --trusted-host pypi.local.homeinfra.org
-pip3 download -i http://torch.local.homeinfra.org/whl/ torch --trusted-host torch.local.homeinfra.org
+pip3 download -i https://pypi.local.homeinfra.org/simple/ jinja2 --trusted-host pypi.local.homeinfra.org
+pip3 download -i https://torch.local.homeinfra.org/whl/ torch --trusted-host torch.local.homeinfra.org
 ```
 
+也可以通过查看 `./test/scripts` 下的测试脚本验证其他镜像站是否正常工作。
+
+
 ### Deployment
 
 
@@ -59,19 +71,16 @@ pip3 download -i http://torch.local.homeinfra.org/whl/ torch --trusted-host torc
 
 - docker + docker-compose.
 - 一个域名，设置 `*.yourdomain` 的A记录指向您服务器的IP.
-    - `*.local.homeinfra.org` 默认指向 `127.0.0.1`，本地测试可以直接使用。
 - 代理服务器（如有必要）.
 
-> 如果需要使用HTTPS，可以在外层新增一个HTTP网关（如Caddy），请参考后续章节。
-> **对于DockerHub镜像，我们强烈建议启用HTTPS**。
-
+安全起见，我们默认开启了HTTPS，通过 `docker-compose.yml` 中默认使用自签名证书。
+我们也提供了一个基于 Caddy 的 HTTPS 部署方案，具体请参考下一节。
 
 修改 `.env` 文件，设置下列参数：
 
 - `BASE_DOMAIN`: 基础域名，如 `local.homeinfra.org`，可以通过 `*.local.homeinfra.org` 访问镜像站。
 - `RPC_SECRET`：Aria2的RPC密钥。
-- `all_proxy`：代理服务器地址，如有必要。
-- `SCHEME`：`http` 或 `https`。
+- `*_proxy`：代理服务器地址，如有必要。
 
 配置完成之后，执行以下命令：
 
@@ -81,7 +90,7 @@ docker-compose up
 
 #### HTTPS
 
-在 .env 中配置 `SCHEME=https` 与 CLOUDFLARE_DNS_API_TOKEN。
+在 .env 中配置 CLOUDFLARE_DNS_API_TOKEN。
 本项目提供了一个基于Cloudflare DNS的 `Caddyfile` 和 `Dockerfile`。如果您希望使用其他DNS Provider或者LB，请自行修改。
 
 配置完成后，使用以下命令代替上述的`docker-compose up` (多了 `-f docker-compose-caddy.yml`) ：
@@ -109,22 +118,18 @@ LightMirrors依赖于两个组件：
 
 docker pull 的时候添加前缀 `docker.local.homeinfra.org` 即可。
 
-> 请注意：当 `SCHEME=http` 且 `DOCKER_BUILDKIT=1` 时，
-> Dockerfile 中的 `FROM docker.local.homeinfra.org/xxx` 语法默认将从 https 站点拉取镜像，
-> 此时将会出现错误。请使用 `docker pull`代替，或者尝试设置环境变量 `DOCKER_BUILDKIT=0`
-
 ### PyPI
 
-- https: `pip install jinja2 --index-url https://pypi.local.homeinfra.org/simple/`
-- http: `pip install jinja2 --index-url http://pypi.local.homeinfra.org/simple/ --trusted-host pypi.local.homeinfra.org`
+- `pip install jinja2 --index-url https://pypi.local.homeinfra.org/simple/ --trusted-host pypi.local.homeinfra.org`
+
+> 当使用自签名证书时，需要添加 `--trusted-host`。
+
 
 ### PyTorch
 
-- https: `pip install torch --index-url https://torch.local.homeinfra.org/whl/`
-- http: `pip install torch --index-url http://torch.local.homeinfra.org/whl/ --trusted-host torch.local.homeinfra.org`
+- `pip install torch --index-url https://torch.local.homeinfra.org/whl/`
 
 把`download.pytorch.org`替换为 `torch.local.homeinfra.org` ，
-如果使用的是http，还需添加 `--trusted-host torch.local.homeinfra.org`。
 
 > 可以根据不同的硬件类型，切换不同的索引，如 https://download.pytorch.org/whl/cpu ，其中 `cpu`
 > 可以替换为cu116/cu118/cu121/rocm5.4.2 等等。
@@ -134,8 +139,7 @@ docker pull 的时候添加前缀 `docker.local.homeinfra.org` 即可。
 
 npm 命令后加上 `--registry https://npm.local.homeinfra.org` 即可。
 
-- https: `npm install -S express --registry https://npm.local.homeinfra.org`
-- http: `npm install -S express --registry http://npm.local.homeinfra.org`
+- `npm install -S express --registry https://npm.local.homeinfra.org`
 
 ## Star History
 
diff --git a/test/scripts/python.sh b/test/scripts/python.sh
index 155da61..9e76a9c 100644
--- a/test/scripts/python.sh
+++ b/test/scripts/python.sh
@@ -3,7 +3,7 @@ set -ex
 cat /scripts/certs/certificate.crt >> /etc/ssl/certs/ca-certificates.crt
 
 pip config set global.index-url https://pypi.local.homeinfra.org/simple
- pip config set global.trusted-host pypi.local.homeinfra.org
+pip config set global.trusted-host pypi.local.homeinfra.org
 pip download jinja2 --dest /tmp/pypi/