** 注意：这是 yourls 镜像 的 i386 架构构建的“按架构”仓库——更多信息，请参见镜像文档中的“除 amd64 外的架构？”和*镜像 FAQ 中的“Git 中镜像的源代码已更改，现在该怎么办？”。

快速参考

-** 维护者：**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

快速参考（续）

-** 提交 issue 的位置：[*]

-** 支持的架构：**(更多信息)
amd64、arm32v5、arm32v6、arm32v7、arm64v8、i386、ppc64le、riscv64、s390x

-** 已发布的镜像 artifact 详情：**repo-info 仓库的 repos/yourls/ 目录（历史记录）
（镜像元数据、传输大小等）

-** 镜像更新：**official-images 仓库的 library/yourls 标签
official-images 仓库的 library/yourls 文件（历史记录）

-** 本描述的来源：**docs 仓库的 yourls/ 目录（历史记录）

什么是 YOURLS？

YOURLS 是一组 PHP 脚本，允许你运行自己的 URL 缩短器。你将拥有对数据的完全控制权、详细的统计信息、分析功能、插件等。它是免费的。

github.com/YOURLS/YOURLS

!logo

如何使用此镜像

启动 i386/yourls 服务器实例

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

YOURLS 实例接受多个环境变量用于配置，详见下文“环境变量”部分。

如果你想使用外部数据库而非 mysql 容器，请通过 YOURLS_DB_HOST 指定主机名和端口，以及 YOURLS_DB_PASS 中的密码和 YOURLS_DB_USER 中的用户名（如果不是 root）：

bash
docker run \
    --name some-yourls \
    --detach \
    --env YOURLS_DB_HOST=... \
    --env YOURLS_DB_USER=... \
    --env YOURLS_DB_PASS=... \
    i386/yourls

连接到 YOURLS 管理界面

如果你希望从主机访问实例而无需容器 IP，可以使用标准端口映射：

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

然后，在浏览器中通过 http://localhost:8080/admin/ 或 http://<主机 IP>:8080/admin/ 访问。

**注意：**首次实例化时，访问根目录会产生错误。请通过路径 /admin/ 访问 YOURLS 管理界面。

环境变量

启动 yourls 镜像时，你可以通过在 docker run 命令行上传递一个或多个环境变量来调整 YOURLS 实例的配置。
YOURLS 实例接受多个用于配置的环境变量。
使用此 Docker 镜像时，以下是一些值得注意/重要的示例。

YOURLS_SITE

必填。
YOURLS 实例 URL，无尾随斜杠，小写。

示例：YOURLS_SITE="[***]"

YOURLS_USER

必填。
YOURLS 实例用户名。

示例：YOURLS_USER="example_username"

YOURLS_PASS

必填。
YOURLS 实例密码。

示例：YOURLS_PASS="example_password"

YOURLS_DB_HOST、YOURLS_DB_USER、YOURLS_DB_PASS

如果链接了 mysql 容器，则可选。

数据库的主机、用户（默认 root）和密码。

YOURLS_DB_NAME

可选。
数据库名称，默认为 yourls。安装 YOURLS 前必须已创建该数据库。

YOURLS_DB_PREFIX

可选。
数据库表前缀，默认为 yourls_。仅在需要覆盖默认表前缀时设置。

Docker 密钥

作为通过环境变量传递敏感信息的替代方法，可以在前面列出的环境变量后附加 _FILE，使初始化脚本从容器中存在的文件加载这些变量的值。特别是，这可用于从存储在 /run/secrets/<secret_name> 文件中的 Docker 密钥加载密码。例如：

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

目前，支持 YOURLS_DB_HOST、YOURLS_DB_USER、YOURLS_DB_PASS、YOURLS_DB_NAME、YOURLS_DB_PREFIX、YOURLS_SITE、YOURLS_USER 和 YOURLS_PASS 使用此方式。

... 通过 docker compose

yourls 的 compose.yaml 示例：

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

运行 docker compose up，等待其完全初始化，然后访问 http://localhost:8080/admin/ 或 http://<主机 IP>:8080/admin/（视情况而定）。

添加额外的库/扩展

此镜像不提供任何额外的 PHP 扩展或其他库，即使它们是流行插件所必需的。可能的插件数量无限，它们可能需要 PHP 支持的任何扩展。包含所有存在的 PHP 扩展会显著增加镜像大小。

如果需要额外的 PHP 扩展，你需要基于此镜像创建自己的镜像。php 镜像的文档 解释了如何编译额外的扩展。

包含持久化用户内容

将包含你的插件、页面或语言的卷挂载到适当的目录；然后通过“admin”界面应用它们。确保用户具有读/写/执行权限：

• 插件放在 /var/www/html/user/plugins/ 的子目录中
• 页面放在 /var/www/html/user/pages/ 的子目录中
• 语言文件放在 /var/www/html/user/languages/ 的子目录中

如果你希望在镜像中提供额外内容以部署到多个安装中，请将其放在 /usr/src/yourls/ 下的相同目录中（容器首次启动时会复制到 /var/www/html/）。

镜像变体

i386/yourls 镜像有多种版本，每种版本都针对特定用例设计。

i386/yourls:<version>

这是默认镜像。如果你不确定自己的需求，可能需要使用此版本。它设计为既可作为临时容器（挂载源代码并启动容器以启动应用），也可作为构建其他镜像的基础。

i386/yourls:<version>-fpm

此变体包含 PHP 的 FastCGI 进程管理器（FPM），这是推荐的 PHP FastCGI 实现。

要使用此镜像变体，需要某种反向代理（如 NGINX、Apache 或其他支持 FastCGI 协议的工具）。

一些可能有帮助的资源：

• FPM 的***配置参考
• @md5 的简化示例
• Pascal Landau 的详细文章
• Stack Overflow 讨论
• Apache httpd Wiki 示例

**警告：**FastCGI 协议本质上是可信的，因此在私有容器网络外暴露是极其不安全的——除非你确切知道自己在做什么（并愿意承担极端风险），否则不要将 Docker 的 --publish（-p）标志与此镜像变体一起使用。

许可证

查看此镜像中包含的软件的许可证信息。

与所有 Docker 镜像一样，这些镜像可能还包含其他受其他许可证约束的软件（如基础发行版中的 Bash 等，以及主要软件的任何直接或间接依赖项）。

一些能够自动检测到的额外许可证信息可能位于 repo-info 仓库的 yourls/ 目录中。

至于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用都符合其中包含的所有软件的相关许可证。