supersandro2000/yourls

YOURLS

镜像概述和主要用途

YOURLS（Your Own URL Shortener）是一个开源的URL缩短与分析工具，允许用户创建、管理和跟踪短链接。本Docker镜像提供YOURLS的容器化部署方案，简化了依赖配置流程，帮助用户快速搭建自托管的URL缩短服务。

核心功能和特性

• 容器化部署：基于Docker封装，无需手动配置系统依赖，一键启动服务
• 环境变量配置：通过环境变量灵活设置关键参数，包括管理员密码、域名和数据库连接信息
• 数据持久化：支持连接外部数据库（如MySQL），确保短链接数据持久存储
• 安全增强：通过COOKIE_KEY参数提升服务安全性，可使用pwgen工具生成高强度密钥
• 服务稳定性：支持Docker重启策略（如unless-stopped），保障服务持续运行

使用场景和适用范围

• 个人用户：搭建私有短链接服务，管理个人URL资源
• 企业/团队：内部URL统一管理，规范短链接使用，便于分享和数据统计
• 开发者：集成到应用系统中，提供自定义短链接生成功能
• 隐私敏感场景：自托管模式确保短链接数据不泄露给第三方平台

使用方法和配置说明

环境变量说明

Docker Compose配置示例

创建docker-compose.yml文件，内容如下：

yaml
---
version: "3"
services:
  yourls:
    image: docker.xuanyuan.run/supersandro2000/yourls
    environment:
      - ADMIN_PASSWORD=PASSWORD       # 管理员密码，参考YOURLS官方文档设置
      - COOKIE_KEY=super_secret       # 使用pwgen 40 1生成的安全密钥
      - DOMAIN=yourls.example.com     # 服务域名
      - DB_HOST=db_yourls             # 数据库主机（需确保数据库服务已部署）
      - DB_NAME=yourls                # 数据库名称
      - DB_PASSWORD=secret_password   # 数据库密码
      - DB_USER=yourls                # 数据库用户名
    restart: unless-stopped           # 除非手动停止，否则自动重启服务

启动服务

在docker-compose.yml文件所在目录执行以下命令启动服务：

bash
docker-compose up -d

服务启动后，通过浏览器访问配置的DOMAIN即可使用YOURLS服务。

生成COOKIE_KEY

COOKIE_KEY用于增强服务安全性，推荐使用pwgen工具生成40位随机字符串：

bash
pwgen 40 1

将生成的字符串作为COOKIE_KEY环境变量的值配置到服务中。