Skip to content

Shortener

Office Web - Source - Docker Image - Document


Shortener 是一个使用 Rust 编写的高性能 URL 短链接服务。


使用

  1. 配置文件 config.toml
  2. 若需要使用缓存,需要配置 valkey 缓存
    1. 取消 compose.yaml 中的 valkey 配置的注释。
    2. 修改配置文件 config.toml 中的 cache.enabled 字段为 true
    3. 修改配置文件 config.toml 中的 cache.type 字段为 valkey
  3. 若需要 IP 数据,需要配置 ip2region 数据库
    1. 下载 ip2region.xdb ,保存至 ./data/ip2region.xdb
    2. 修改配置文件 config.toml 中的 geoip.enabled 字段为 true
  4. 启动
    bash
    docker compose up -d
  5. 配置 Nginx 反向代理
    nginx
    # 前端配置
    location / {
        proxy_pass   http://127.0.0.1:8080;
    
        client_max_body_size  1024m;
        proxy_set_header Host $host:$server_port;
    
        proxy_set_header X-Real-Ip $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;  # 透传 HTTPS 协议标识
        proxy_set_header X-Forwarded-Ssl on;         # 明确 SSL 启用状态
    
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
    
    # 对接 API
    location /api/ {
        proxy_pass   http://127.0.0.1:8081/api/;
    
        client_max_body_size  1024m;
        proxy_set_header Host $host:$server_port;
    
        proxy_set_header X-Real-Ip $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;  # 透传 HTTPS 协议标识
        proxy_set_header X-Forwarded-Ssl on;         # 明确 SSL 启用状态
    
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }

Released under the Apache-2.0 License.