fuwn/september

September

概述

September是一个用Rust编写的简单高效的Gemini到HTTP代理，旨在将Gemini协议内容转换为HTTP协议，使普通浏览器能够访问Gemini胶囊。

核心功能与特性

• 轻量高效：基于Rust构建，性能优异且资源占用低
• 灵活配置：完全通过环境变量配置，原生支持Docker部署
• 代理转换：将Gemini协议内容转换为HTTP可访问的HTML格式
• 自定义样式：支持引入外部CSS文件美化HTML响应
• 细粒度控制：可配置保留特定Gemini URL或域名不被代理

使用场景

适用于需要通过HTTP协议访问Gemini胶囊的场景，例如：

• 让不支持Gemini协议的浏览器访问Gemini内容
• 构建Gemini胶囊的HTTP镜像站点
• 在不支持Gemini的环境中展示Gemini内容

使用方法

Docker部署

shell
docker run -d \
  [-e ROOT="gemini://fuwn.me"] \
  [-e PORT="8080"] \
  [-e CSS_EXTERNAL="https://example.com/style.css"] \
  fuwn/september:latest

Docker Compose部署

编辑docker-compose.yaml文件后执行部署：

yaml
version: '3'
services:
  september:
    image: fuwn/september:latest
    environment:
      - ROOT=gemini://fuwn.me
      - PORT=8080
      - CSS_EXTERNAL=https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css
    ports:
      - "8080:8080"

启动命令：

shell
docker-compose up -d

可执行文件运行

直接运行可执行文件（需预先获取二进制文件）：

shell
# 直接设置环境变量
[ ROOT="gemini://fuwn.me" ] [ PORT="8080"] [ CSS_EXTERNAL="https://example.com/style.css"] ./september

# 或使用.env文件
# 创建.env文件
cat > .env << EOF
ROOT=gemini://fuwn.me
PORT=8080
CSS_EXTERNAL=https://example.com/style.css
EOF

# 运行
./september

配置说明

所有配置通过环境变量完成，以下是详细参数说明：

PORT

指定服务绑定端口。Docker部署时通常无需修改。

• 默认值：80（若未提供或解析失败时）
• 类型：u16（1-65535）
• 示例：

  dotenv
  PORT=8080
  

ROOT

设置非"/proxy"路由时的根Gemini胶囊。

• 默认值："gemini://fuwn.me"
• 示例：

  dotenv
  ROOT=gemini://fuwn.me
  

CSS_EXTERNAL

应用于HTML响应的外部CSS文件URL。未提供时HTML无样式。

• 示例：

  dotenv
  CSS_EXTERNAL=https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css
  

KEEP_GEMINI_EXACT

保留完全匹配的Gemini URL不被代理。

• 示例：

  dotenv
  # 仅保留"gemini://fuwn.me/skills"不被代理
  KEEP_GEMINI_EXACT=gemini://fuwn.me/skills
  

KEEP_GEMINI_DOMAIN

基于域名保留Gemini URL不被代理（与KEEP_GEMINI_EXACT类似，但作用于整个域名）。

• 示例：

  dotenv
  KEEP_GEMINI_DOMAIN=fuwn.me
  

PROXY_BY_DEFAULT

控制是否默认代理所有Gemini URL。

• 默认值：true
• 示例：

  dotenv
  PROXY_BY_DEFAULT=false
  

使用案例

以下是使用September的Gemini胶囊示例：

• <[***]>
• <[***]>

许可证

本项目采用https://github.com/gemrest/september/blob/main/LICENSE%E8%AE%B8%E5%8F%AF%E8%AF%81%E3%80%82