YOURLS Docker镜像文档

概述

YOURLS（Your Own URL Shortener）是一套PHP脚本，可让您搭建自己的URL缩短服务。通过该Docker镜像，您可以快速部署YOURLS实例，实现对URL缩短服务的完全控制，包括数据管理、详细统计分析、插件扩展等功能，且完全免费开源。

快速参考

维护者

YOURLS

获取帮助

Docker社区Slack、Server Fault、Unix & Linux 或 Stack Overflow

支持的标签及对应的Dockerfile链接

• 1.10.2-apache, 1.10-apache, 1-apache, apache, 1.10.2, 1.10, 1, latest
• 1.10.2-fpm, 1.10-fpm, 1-fpm, fpm
• 1.10.2-fpm-alpine, 1.10-fpm-alpine, 1-fpm-alpine, fpm-alpine

快速参考（续）

问题提交地址

[***]

支持的架构

(更多信息)
amd64、arm32v5、arm32v6、arm32v7、arm64v8、i386、ppc64le、riscv64、s390x

镜像详情

repo-info仓库的repos/yourls/目录（历史记录）
（包含镜像元数据、传输大小等）

镜像更新

official-images仓库的library/yourls标签
official-images仓库的library/yourls文件（历史记录）

描述来源

docs仓库的yourls/目录（历史记录）

核心功能与特性

• 自建URL缩短服务：完全掌控URL缩短过程，无需依赖第三方服务
• 数据所有权：所有缩短的URL数据存储在您自己的服务器上
• 详细统计分析：提供点击量、来源、设备等详细访问统计
• 插件扩展：支持丰富的插件生态，可扩展功能
• 多架构支持：兼容多种硬件架构，部署灵活
• 多种镜像变体：提供Apache、FPM、Alpine等不同版本，满足不同部署需求

使用场景

• 企业内部URL管理与缩短
• 个人博客或网站的URL优化
• 营销活动中的链接跟踪与分析
• 需要数据隐私保护的URL缩短需求
• 开发或测试环境中的临时URL管理

使用方法与配置说明

启动YOURLS服务实例

基础启动命令

bash
docker run \
    --name some-yourls \
    --detach \
    --network some-network \
    --env YOURLS_SITE="[***]" \
    --env YOURLS_USER="example_username" \
    --env YOURLS_PASS="example_password" \
    yourls

使用外部数据库

若需使用外部数据库而非链接的mysql容器，需指定数据库主机、端口、用户和密码：

bash
docker run \
    --name some-yourls \
    --detach \
    --env YOURLS_DB_HOST=数据库主机地址 \
    --env YOURLS_DB_USER=数据库用户名 \
    --env YOURLS_DB_PASS=数据库密码 \
    yourls

连接YOURLS管理界面

通过端口映射可从主机直接访问YOURLS实例：

bash
docker run \
    --name some-yourls \
    --detach \
    --network some-network \
    --publish 8080:80 \
    yourls

然后通过浏览器访问 http://localhost:8080/admin/ 或 http://<主机IP>:8080/admin/ 进入管理界面。

注意：首次启动时，访问根目录会产生错误，需通过/admin/路径进入管理界面。

环境变量配置

启动镜像时，可通过环境变量调整YOURLS配置，以下是关键变量说明：

YOURLS_SITE

• 必填
• YOURLS实例URL，无尾部斜杠，小写
• 示例：YOURLS_SITE="[***]"

YOURLS_USER

• 必填
• YOURLS管理员用户名
• 示例：YOURLS_USER="admin"

YOURLS_PASS

• 必填
• YOURLS管理员密码
• 示例：YOURLS_PASS="secure_password"

YOURLS_DB_HOST, YOURLS_DB_USER, YOURLS_DB_PASS

• 链接mysql容器时可选
• 数据库主机、用户名（默认root）和密码
• 示例：YOURLS_DB_HOST=mysql:3306、YOURLS_DB_USER=yourls、YOURLS_DB_PASS=db_password

YOURLS_DB_NAME

• 可选
• 数据库名称，默认yourls（需提前创建数据库）
• 示例：YOURLS_DB_NAME="yourls_db"

YOURLS_DB_PREFIX

• 可选
• 数据库表前缀，默认yourls_
• 示例：YOURLS_DB_PREFIX="url_"

Docker Secrets

支持通过Docker Secrets传递敏感信息，只需在环境变量名后添加_FILE，并指定包含密钥的文件路径：

bash
docker run \
    --name some-yourls \
    --detach \
    --env YOURLS_DB_PASS_FILE=/run/secrets/mysql-root \
    yourls

目前支持的变量：YOURLS_DB_HOST, YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_PREFIX, YOURLS_SITE, YOURLS_USER, YOURLS_PASS。

Docker Compose配置示例

yaml
name: yourls
services:
  yourls:
    image: yourls
    restart: always
    depends_on:
      - mysql
    ports:
      - 8080:80
    environment:
      YOURLS_DB_PASS: example_db_password
      YOURLS_SITE: [***]
      YOURLS_USER: admin
      YOURLS_PASS: admin_password
  mysql:
    image: mysql
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: example_db_password
      MYSQL_DATABASE: yourls
    volumes:
      - db:/var/lib/mysql

volumes:
  db:

启动命令：docker compose up -d，然后访问 http://localhost:8080/admin/ 进入管理界面。

添加额外PHP扩展

本镜像未包含所有可能的PHP扩展，如需添加，需基于本镜像创建自定义镜像。参考php镜像文档了解如何编译扩展。

持久化用户内容

可通过挂载卷实现插件、页面和语言文件的持久化：

• 插件：挂载到 /var/www/html/user/plugins/ 子目录
• 页面：挂载到 /var/www/html/user/pages/ 子目录
• 语言：挂载到 /var/www/html/user/languages/ 子目录

如需在多实例中使用相同内容，可在构建自定义镜像时将内容放置于 /usr/src/yourls/ 下对应目录（容器首次启动时会复制到 /var/www/html/）。

镜像变体

yourls:<version>（默认变体）

基于Apache的镜像，适合大多数场景，可直接使用或作为基础镜像构建自定义版本。

yourls:<version>-fpm

包含PHP-FPM（FastCGI Process Manager），需配合反向代理（如NGINX、Apache）使用，适合需要更高性能的场景。

警告：FastCGI协议本身不提供安全保护，请勿将此变体直接暴露到公网，需通过反向代理访问。

yourls:<version>-fpm-alpine

基于Alpine Linux的FPM变体，体积更小，适合资源受限环境，但可能需要额外配置以支持某些扩展。

许可证

YOURLS软件许可证信息见GitHub仓库。

本镜像可能包含其他软件，其许可证需用户自行确认合规性。镜像元数据中的许可证信息可参考repo-info仓库的yourls/目录。

使用前请确保遵守所有包含软件的相关许可证要求。