注意： 这是yourls官方镜像的mips64le架构"per-architecture"仓库——更多信息请参见官方镜像文档中的"除amd64之外的架构？"和官方镜像FAQ中的"镜像源在Git中已更改，现在该怎么办？"。

快速参考

• 维护者：
  YOURLS

• 获取帮助：
  Docker社区Slack、Server Fault、Unix & Linux 或 Stack Overflow

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

警告： 此镜像在mips64le架构上不受支持

快速参考（续）

• 问题提交地址：
  [***]

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

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

• 镜像更新：
  official-images仓库的library/yourls标签
  official-images仓库的library/yourls文件 (历史记录)

• 本描述的来源：
  docs仓库的yourls/目录 (历史记录)

什么是YOURLS？

YOURLS是一套PHP脚本，允许您运行自己的URL缩短器。您将完全控制您的数据、详细统计、分析、插件等。它是免费的。

github.com/YOURLS/YOURLS

!logo

如何使用此镜像

启动mips64le/yourls服务器实例

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

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

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

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

连接YOURLS管理界面

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

docker run \
    --name some-yourls \
    --detach \
    --network some-network \
    --publish 8080:8080 \
    mips64le/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 Secrets

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

docker run \
    --name some-yourls \
    --detach \
    --env YOURLS_DB_PASS_FILE=/run/secrets/mysql-root \
    mips64le/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示例：

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/）。

许可证

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

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

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

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