johansteffens/foxy

Foxy 🦊

https://img.shields.io/github/actions/workflow/status/johan-steffens/foxy/crate.yml?label=crate-build](https://github.com/johan-steffens/foxy/actions/workflows/crate.yml) https://img.shields.io/github/actions/workflow/status/johan-steffens/foxy/docker.yml?label=docker-build](https://github.com/johan-steffens/foxy/actions/workflows/crate.yml) https://img.shields.io/crates/v/foxy-io](https://crates.io/crates/foxy-io) https://img.shields.io/crates/d/foxy-io](https://crates.io/crates/foxy-io) https://img.shields.io/badge/rust-1.70%2B-blue](https://blog.rust-lang.org/2023/06/01/Rust-1.70.0.html) https://img.shields.io/docker/v/johansteffens/foxy?label=docker%20tag](https://hub.docker.com/r/johansteffens/foxy) https://img.shields.io/docker/pulls/johansteffens/foxy](https://hub.docker.com/r/johansteffens/foxy) https://img.shields.io/github/license/johan-steffens/foxy](https://github.com/johan-steffens/foxy/blob/main/LICENSE.md)

镜像概述

Foxy是一个轻量、配置驱动且高度可扩展的Rust HTTP代理库，基于Tokio和Hyper构建现代异步架构，旨在提供高效、灵活的HTTP请求处理能力。

核心功能

• 🛣️ 强大路由：基于谓词的路由机制，支持路径模式、HTTP方法、请求头及查询参数匹配
• 🔄 灵活过滤器：请求/响应的前置与后置处理过滤器，可实现自定义修改逻辑
• ⚙️ 分层配置：支持从文件和环境变量加载配置，满足多场景需求
• 🌐 精细控制：路由专属过滤器链，实现精准的请求处理
• 🔒 可插拔安全链：基于提供者的配置化请求认证，内置多种认证提供者
• 🚀 高性能异步架构：依托Tokio和Hyper框架，确保高并发处理能力
• 📦 轻量依赖：核心功能依赖极少，保持镜像体积精简
• 🧩 高度可扩展：通过简单的 trait 支持自定义谓词、过滤器及安全提供者

使用场景

1. 内部服务代理：用于微服务架构中服务间的请求转发与路由管理
2. API网关：作为API入口，实现请求过滤、认证及流量控制
3. 请求处理中间件：对HTTP请求/响应进行自定义修改（如添加头信息、转换格式）
4. 开发测试工具：模拟代理场景，调试HTTP请求流程

配置说明

Foxy支持通过配置文件和环境变量进行参数设置。核心配置项包括：

• 监听地址与端口
• 路由规则（路径、方法、头信息等匹配条件）
• 过滤器链（前置/后置处理逻辑）
• 安全认证提供者配置

Docker部署示例

前提条件

• Docker 20.10及以上版本

拉取镜像

bash
docker pull johansteffens/foxy:latest

启动默认配置的代理

暴露容器8080端口到主机：

bash
docker run --rm -p 8080:8080 johansteffens/foxy:latest

使用自定义配置文件

1. 在主机创建config.json配置文件（确保绑定地址为0.0.0.0）
2. 挂载配置文件并指定环境变量：

bash
docker run --rm -p 8080:8080 \
  -v "$(pwd)/config.json:/app/config.json:ro" \
  -e FOXY_CONFIG_FILE=/app/config.json \
  -e RUST_LOG=debug \
  johansteffens/foxy:latest

Docker Compose部署

创建docker-compose.yml文件：

yaml
version: "3.9"
services:
  foxy:
    image: johansteffens/foxy:latest
    container_name: foxy
    ports:
      - "8080:8080"
    environment:
      FOXY_CONFIG_FILE: /config/config.json
    volumes:
      - ./config.json:/config/config.json:ro

启动服务：

bash
docker compose up -d

更新配置后重启服务：

bash
docker compose restart foxy