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

本项目已停止维护。
已使用 Rust 语言重构,新项目:https://github.com/jetsung/shortener

• 配置前端:shortener-frontend
• 命令行工具:shortener

go install go.xoder.cn/shortener/cmd/shortener@main

版本: latest, main, <TAG>

git clone https://git.jetsung.com/idev/shortener-server.git
cd shortener-server

mkdir -p config/dev
cp config/config.toml config/dev/
# 修改开发环境的配置文件
vi config/dev/config.toml

go run .

go build
# 支持 GoReleaser 方式构建
goreleaser release --snapshot --clean

just --list

• 配置 Nginx 反向代理(若使用管理界面作为入口域名,可忽略此步)

  点击展开/折叠

  # 对接 API
  location /api/ {
   proxy_pass http://127.0.0.1:8080/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";
   proxy_connect_timeout 99999;
  }

1. 下载发行版的安装包:deb / rpm
2. 安装

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

3. 配置文件 config.toml
4. 启动

   systemctl start shortener-server
   systemctl enable shortener-server

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

1. 下载并解压到指定目录

1. 配置文件 config.toml

2. 若需要使用缓存,需要配置 valkey 缓存

   1. 取消 compose.yml 中的 valkey 配置的注释。
   2. 修改配置文件 config.toml 中的 cache.enabled 字段为 true。
   3. 修改配置文件 config.toml 中的 cache.type 字段为 valkey。

3. 若需要 IP 数据,需要配置 ip2region 数据库

   1. 下载 ip2region V4、V6 ,保存至 ./data/ip2region.xdb。
   2. 修改配置文件 config.toml 中的 geoip.enabled 字段为 true,path 修改为 xdb 的相对路径,version 字段的值为 "4"或者 "6"。

4. 启动

   docker compose up -d

5. 配置 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";
    proxy_connect_timeout 99999;
   }

• MyCode
• Framagit
• GitCode
• GitHub