Souin 项目使用教程

Souin 项目使用教程

souin An HTTP cache system, RFC compliant, compatible with @tyktechnologies, @traefik, @caddyserver, @go-chi, @bnkamalesh, @beego, @devfeel, @labstack, @gofiber, @go-goyave, @go-kratos, @gin-gonic, @roadrunner-server, @zalando, @zeromicro, @nginx and @apache 项目地址: https://gitcode.com/gh_mirrors/so/souin

1. 项目介绍

Souin 是一个适用于各种反向代理的 HTTP 缓存系统。它可以作为插件集成到你喜欢的反向代理中，如 Træfik、Caddy、Tyk 等，也可以直接部署在 Apache、Nginx 等服务器上。Souin 完全符合 RFC 标准，支持 Vary、请求合并、过期缓存控制等特性，并且支持 Cache-Status HTTP 响应头、YKey 组、ESI 标签等功能。

2. 项目快速启动

2.1 安装 Souin

你可以通过 Docker 快速启动 Souin。以下是一个简单的 Docker Compose 配置示例：

version: '3'
services:
  souin:
    image: darkweak/souin:latest
    ports:
      - "80:80"
    volumes:
      - ./config:/config
    environment:
      - SOUIN_CONFIG_PATH=/config/souin.yml

2.2 配置 Souin

在 ./config 目录下创建一个 souin.yml 配置文件，内容如下：

default_cache:
  ttl: 10s
reverse_proxy_url: 'http://traefik'

2.3 启动 Souin

在项目根目录下运行以下命令启动 Souin：

docker-compose up -d

3. 应用案例和最佳实践

3.1 集成到 Træfik

Souin 可以作为 Træfik 的插件使用。以下是一个简单的 Træfik 配置示例：

http:
  routers:
    my-router:
      rule: "Host(`example.com`)"
      service: my-service
      middlewares:
        - souin-cache
  services:
    my-service:
      loadBalancer:
        servers:
          - url: "http://backend:80"
  middlewares:
    souin-cache:
      plugin:
        souin:
          default_cache:
            ttl: 10s

3.2 使用 CDN 加速

Souin 支持与 CDN 集成，以下是一个使用 Fastly 作为 CDN 的配置示例：

cdn:
  api_key: XXXX
  provider: fastly
  strategy: soft
  dynamic: true

4. 典型生态项目

4.1 Træfik

Træfik 是一个现代化的反向代理和负载均衡器，Souin 可以作为其插件使用，提供高效的 HTTP 缓存功能。

4.2 Caddy

Caddy 是一个用 Go 编写的 HTTP/2 Web 服务器，Souin 可以作为其模块集成，提供强大的缓存支持。

4.3 Tyk

Tyk 是一个开源的 API 网关，Souin 可以作为其插件使用，提供高效的缓存机制，加速 API 响应。

通过以上步骤，你可以快速上手并使用 Souin 项目，提升你的反向代理性能。

souin An HTTP cache system, RFC compliant, compatible with @tyktechnologies, @traefik, @caddyserver, @go-chi, @bnkamalesh, @beego, @devfeel, @labstack, @gofiber, @go-goyave, @go-kratos, @gin-gonic, @roadrunner-server, @zalando, @zeromicro, @nginx and @apache 项目地址: https://gitcode.com/gh_mirrors/so/souin