sineware/static-proxy

Sineware Static HTTP Proxy

镜像概述和主要用途

Sineware Static HTTP Proxy是一个生成网站本地静态副本并提供服务的工具。它通过向客户端提供受控的静态版本，保护Wordpress等动态后端免受直接***，减少直接暴露风险。

核心功能和特性

• 生成并本地存储网站静态副本，减少对动态后端的直接访问
• 通过静态版本隔离动态后端，降低直接***面
• 支持路径黑白名单控制，限制访问范围
• 捕获并重定向POST请求，避免直接传递至后端
• 提供API接口用于刷新静态缓存，确保内容更新

使用场景和适用范围

适用于需要保护动态网站后端（如Wordpress）的场景，尤其适合：

• 希望减少动态后端暴露风险的网站管理员
• 需要控制访问路径的安全敏感应用
• 需要静态化处理但仍需接收用户提交数据的场景

环境变量配置

以下环境变量用于配置代理服务：

bash
API_KEY=abc123 # 访问/sw-api/refresh端点的API密钥（在Authorization头中使用"Bearer <token>"格式）
UPSTREAM_URL="https://sineware.ca" # 后端服务的公开/应用配置URL
UPSTREAM_INTERNAL_URL="" # 可选，指定Static Proxy访问上游服务的内部URL（如绕过负载均衡器）
UPSTREAM_POST_URL="" # 接收POST请求JSON转发的目标URL
HOST_URL="http://localhost:3000" # 静态服务器的托管URL
WHITELIST_PATHS="" # 可选，逗号分隔的允许路由路径（仅允许这些路径）
BLACKLIST_PATHS="/wp-admin,/wp-login,/xmlrpc" # 逗号分隔的禁止路由路径

处理POST请求

所有POST请求（包括URL编码和请求体）会被捕获且不直接传递至后端。若配置了UPSTREAM_POST_URL，请求会被转换为JSON格式转发至该URL；若未配置，则POST请求将被忽略。

刷新静态副本

服务器首次请求时会下载上游内容并缓存。后续请求将直接提供缓存内容，不再访问上游。当上游内容更新时，需通过以下方式刷新缓存：

1. 发送POST请求至/sw-api/refresh端点
2. 请求头中包含Authorization: Bearer <API_KEY>（其中<API_KEY>为配置的环境变量值）
3. 缓存将被失效，下次请求时会重新下载最新内容

部署示例

Docker Run命令

bash
docker run -d \
  -p 3000:3000 \
  -e API_KEY="your_secure_api_key" \
  -e UPSTREAM_URL="https://your-wordpress-site.com" \
  -e HOST_URL="https://static.your-domain.com" \
  -e BLACKLIST_PATHS="/wp-admin,/wp-login,/xmlrpc,/admin" \
  -e UPSTREAM_POST_URL="https://your-backend.com/api/receive-post" \
  sineware/static-proxy

许可证

    Copyright (C) 2023 Seshan Ravikumar

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published
    by the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <[***]>.