mirror of
https://github.com/sky22333/hubproxy.git
synced 2026-08-05 03:24:57 +08:00
update docs
This commit is contained in:
24
README.md
24
README.md
@@ -1,8 +1,14 @@
|
||||
# HubProxy
|
||||
|
||||
**Docker 与 GitHub 加速代理服务器**
|
||||
**Docker 和 GitHub 加速代理服务器**
|
||||
|
||||
一个轻量级、高性能的多功能代理服务,提供 Docker 镜像加速、GitHub 文件加速、下载离线镜像、在线搜索 Docker 镜像等功能。
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img src="https://count.getloli.com/get/@sky22333.hubproxy?theme=rule34" alt="Visitors">
|
||||
</p>
|
||||
|
||||
轻量级、高性能的多功能代理服务,单二进制部署,完全自托管。
|
||||
|
||||
## 特性
|
||||
|
||||
@@ -38,6 +44,8 @@ docker run -d \
|
||||
curl http://127.0.0.1:5000/ready
|
||||
```
|
||||
|
||||
或者网页访问
|
||||
|
||||
### 脚本安装
|
||||
|
||||
自动识别 `amd64` / `arm64` 与 `apt`、`dnf`、`apk` 等包管理器:
|
||||
@@ -52,20 +60,22 @@ curl -fsSL https://raw.githubusercontent.com/sky22333/hubproxy/main/install.sh |
|
||||
|
||||
```bash
|
||||
# Docker 镜像加速(将 yourdomain.com 换成你的 HubProxy 地址)
|
||||
docker pull yourdomain.com/library/nginx:latest
|
||||
docker pull yourdomain.com/nginx
|
||||
|
||||
# GitHub Release 加速(完整 URL 前缀)
|
||||
curl -L -O "https://yourdomain.com/https://github.com/owner/repo/releases/download/v1.0.0/app.tar.gz"
|
||||
wget "https://yourdomain.com/https://github.com/owner/repo/releases/download/v1.0.0/app.tar.gz"
|
||||
|
||||
git clone https://yourdomain.com/https://github.com/sky22333/hubproxy.git
|
||||
```
|
||||
|
||||
> **生产环境建议**:绑定自有域名,通过 Caddy / Nginx 反代并开启 HTTPS,不要长期暴露裸 `http://IP:5000`。详见 [文档](https://sky22333.github.io/hubproxy/getting-started/quick-start/)。
|
||||
> **生产环境建议**:绑定自有域名,通过 Caddy / Nginx 反代并开启 HTTPS,不要长期暴露裸 `http://IP:5000`。详见 [文档](https://docs.52013120.xyz/getting-started/quick-start/)。
|
||||
|
||||
## 文档
|
||||
|
||||
部署架构、完整配置、K8s / NAS、传输特性与 FAQ 见官方文档站(中英双语):
|
||||
|
||||
- [中文文档](https://sky22333.github.io/hubproxy/)
|
||||
- [English](https://sky22333.github.io/hubproxy/en/)
|
||||
- [中文文档](https://docs.52013120.xyz/)
|
||||
- [English](https://docs.52013120.xyz/en/)
|
||||
|
||||
|
||||
## 界面预览
|
||||
|
||||
@@ -10,7 +10,7 @@ npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
访问 http://localhost:4321/hubproxy/(GitHub Pages 子路径与线上一致)。
|
||||
访问 http://localhost:4321/(与线上 `https://docs.52013120.xyz/` 路径一致)。
|
||||
|
||||
## 构建
|
||||
|
||||
@@ -27,7 +27,7 @@ src/content/docs/en/ # 英文文档
|
||||
src/assets/ # logo、hero 等资源
|
||||
public/favicon.svg # 浏览器标签页图标
|
||||
src/styles/custom.css # 自定义样式
|
||||
astro.config.mjs # Starlight 配置(含 base: /hubproxy/)
|
||||
astro.config.mjs # Starlight 配置(site: docs.52013120.xyz)
|
||||
```
|
||||
|
||||
## 贡献
|
||||
@@ -36,4 +36,4 @@ astro.config.mjs # Starlight 配置(含 base: /hubproxy/)
|
||||
2. 侧边栏结构见 `astro.config.mjs`
|
||||
3. 向主仓库提交 PR
|
||||
|
||||
部署由 `.github/workflows/docs.yml` 自动发布至 GitHub Pages。
|
||||
部署由 `.github/workflows/docs.yml` 自动发布至 GitHub Pages;线上域名为 `docs.52013120.xyz`(在 hubproxy 仓库 **Settings → Pages → Custom domain** 配置,DNS 添加 `CNAME docs → sky22333.github.io`)。
|
||||
|
||||
@@ -2,8 +2,8 @@ import { defineConfig } from 'astro/config'
|
||||
import starlight from '@astrojs/starlight'
|
||||
|
||||
export default defineConfig({
|
||||
site: 'https://sky22333.github.io',
|
||||
base: '/hubproxy/',
|
||||
site: 'https://docs.52013120.xyz',
|
||||
base: '/',
|
||||
integrations: [
|
||||
starlight({
|
||||
title: 'HubProxy',
|
||||
|
||||
Reference in New Issue
Block a user