「原创」shortener：基于 Go 语言的短网址/缩址平台

jetsung

shortener：基于 Go 语言的短网址/缩址平台

一个超简单的短网址管理平台。

命令行工具：

# 安装
go install go.dsig.cn/shortener/cmd/shortener@latest

# 查看帮助
shortener help 

Short URL management CLI tool

Usage:
  shortener [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  create      Create a short link
  delete      Delete a short code
  env         Print environment variables
  get         Get a short link
  help        Help about any command
  init        Initialize configuration
  update      Update a short code
  version     Print version information

Flags:
  -h, --help         help for shortener
  -k, --key string   API KEY
  -u, --url string   API URL

Use "shortener [command] --help" for more information about a command.

后端：https://git.jetsung.com/idev/shortener-server
前端：https://git.jetsung.com/idev/shortener-frontend

jetsung

文档

Linux 部署

下载发行版的安装包：deb / rpm

安装

    # deb 安装包
    dpkg -i shortener-server_<VERSION>_linux_amd64.deb

    # rpm 安装包
    rpm -ivh shortener-server_<VERSION>_linux_amd64.rpm

配置文件 config.toml

启动

    systemctl start shortener-server
    systemctl enable shortener-server

配置 Nginx 反向代理（若使用管理界面作为入口域名，可忽略此步）
<details>
<summary>点击展开/折叠</summary>

    # 对接 API
    location /api/ {
        proxy_pass   http://127.0.0.1:8081/api/v1/;

        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";
        proxy_connect_timeout 99999;
    }

</details>

若需要前端管理平台，需要使用 shortener-frontend 。

配置 nginx：
<details>
<summary>点击展开/折叠</summary>

    ...
    listen 80;

    server_name <DOMAIN>;

    index index.html;
    root /data/wwwroot/<DOMAIN>;

    # 对接 API
    location /api/ {
        proxy_pass   http://127.0.0.1:8081/api/v1/;

        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";
        proxy_connect_timeout 99999;
    }

</details>

Docker 部署

配置文件 config.toml
若需要使用缓存，需要配置 valkey 缓存
1. 取消 compose.yml 中的 valkey 配置的注释。
2. 修改配置文件 config.toml 中的 cache.enabled 字段为 true。
3. 修改配置文件 config.toml 中的 cache.type 字段为 valkey。
若需要 IP 数据，需要配置 ip2region 数据库
1. 下载 ip2region.xdb ，保存至 ./data/ip2region.xdb。
2. 修改配置文件 config.toml 中的 geoip.enabled 字段为 true。

启动

    docker compose up -d

配置 Nginx 反向代理
<details>
<summary>点击展开/折叠</summary>

    # 前端配置
    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";
        proxy_connect_timeout 99999;
    }

    # 对接 API
    location /api/ {
        proxy_pass   http://127.0.0.1:8081/api/v1/;

        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";
        proxy_connect_timeout 99999;
    }

</details>