careywong/myurls Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

MyUrls 短链接服务

镜像概述

MyUrls是一款基于golang1.15与Redis实现的本地短链接服务，主要用于实现长链接缩短与短链接还原功能。该服务依赖Redis存储长短链接的映射关系，支持通过Docker快速部署，也可手动编译安装，适用于个人或小型团队搭建本地短链接服务。

核心功能与特性

• 链接处理：支持长链接缩短为短链接，以及短链接还原为原始长链接
• 存储依赖：使用Redis存储长短链接映射关系，确保数据持久化与高效访问
• 灵活配置：支持自定义短链接域名、服务端口、Redis连接参数及链接有效期（TTL）
• 部署便捷：提供Docker及docker-compose部署方案，无需复杂环境配置
• 前端集成：20200330版本起集成前端页面（需自行编译或通过Nginx配置访问）

使用场景

• 个人博客或网站的链接管理，缩短冗长URL
• 社交媒体分享中使用短链接，提升用户体验
• 内部系统中生成临时短链接，控制访问有效期
• 需本地化部署短链接服务，避免依赖第三方平台的场景

依赖环境

Redis服务

本服务依赖Redis存储长短链接映射关系，需确保Redis服务正常运行。

手动安装Redis（Ubuntu系统）

shell
sudo apt-get update

# 安装Redis
sudo add-apt-repository ppa:chris-lea/redis-server -y 
sudo apt-get update 
sudo apt-get install redis-server -y 

部署与使用方法

Docker快速部署

无需安装其他依赖，直接通过Docker或docker-compose部署。

单容器部署

shell
docker run -d --restart always --name myurls careywong/myurls:latest -domain example.com -port 8002 -conn 127.0.0.1:6379 -passwd '' -ttl 90

docker-compose部署

shell
# 克隆仓库
git clone https://github.com/CareyWang/MyUrls.git MyUrls

cd MyUrls
# 复制环境变量示例文件并修改参数
cp .env.example .env

# 启动服务
docker-compose up -d

注：部署前需修改.env文件中的配置参数，如域名、端口等。

手动安装与编译

安装依赖

shell
make install

生成可执行文件

默认生成当前平台可执行文件，输出至build/目录；其他平台可参考Makefile或执行对应go build命令。

shell
bash release.sh

参数说明

通过命令行参数配置服务，执行可执行文件时添加-h查看帮助：

shell
./build/linux-amd64-myurls -h 

Usage of ./build/linux-amd64-myurls:
  -conn string
        Redis连接，格式: host:port (default "127.0.0.1:6379")
  -domain string
        短链接域名，必填项
  -passwd string
        Redis连接密码
  -port int
        服务端口 (default 8002)
  -ttl int
        短链接有效期，单位(天)，默认180天。 (default 180)

启动示例

建议使用pm2开启守护进程：

shell
pm2 start myurls --watch --name myurls -- -domain example.com

前端集成说明

20200330版本已集成前端页面，访问服务根路径（如http://127.0.0.1:8002/）即可使用。

注：如需使用集成前端，需满足以下条件之一：

• 克隆仓库后自行编译，并在代码根目录启动服务
• 通过Nginx单独配置，将root指向public目录下的index.html

API文档

完整API文档请参考：MyUrls API文档

维护者

@CareyWang

贡献指南

接受PR贡献。修改README时，请遵循standard-readme规范。

许可证

MIT © 2020 CareyWang