amd64/yourls

注意： 这是https://hub.docker.com/_/yourls的`amd64`架构构建的“特定架构”仓库——更多信息，请参见官方镜像文档中的“https://github.com/docker-library/official-images#architectures-other-than-amd64”和官方镜像FAQ中的“https://github.com/docker-library/faq#an-images-source-changed-in-git-now-what”。

快速参考

• 维护者：
  https://github.com/YOURLS/containers

• 获取帮助：
  https://dockr.ly/comm-slack、Server Fault、https://unix.stackexchange.com/help/on-topic 或 https://stackoverflow.com/help/on-topic

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

• https://github.com/YOURLS/containers/blob/b3463cd1fe9b9de202a2a220d1ffa502e791ede8/apache/Dockerfile

• https://github.com/YOURLS/containers/blob/b3463cd1fe9b9de202a2a220d1ffa502e791ede8/fpm/Dockerfile

• https://github.com/YOURLS/containers/blob/b3463cd1fe9b9de202a2a220d1ffa502e791ede8/fpm-alpine/Dockerfile

快速参考（续）

• 问题反馈地址：
  https://github.com/YOURLS/containers/issues?q=

• 支持的架构： (https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/yourls/、https://hub.docker.com/r/arm32v5/yourls/、https://hub.docker.com/r/arm32v6/yourls/、https://hub.docker.com/r/arm32v7/yourls/、https://hub.docker.com/r/arm64v8/yourls/、https://hub.docker.com/r/i386/yourls/、https://hub.docker.com/r/ppc64le/yourls/、https://hub.docker.com/r/riscv64/yourls/、https://hub.docker.com/r/s390x/yourls/

• 镜像制品详情：
  https://github.com/docker-library/repo-info/blob/master/repos/yourls（https://github.com/docker-library/repo-info/commits/master/repos/yourls）
  （镜像元数据、传输大小等）

• 镜像更新：
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fyourls
  https://github.com/docker-library/official-images/blob/master/library/yourls（https://github.com/docker-library/official-images/commits/master/library/yourls）

• 本描述的来源：
  https://github.com/docker-library/docs/tree/master/yourls（https://github.com/docker-library/docs/commits/master/yourls）

什么是YOURLS？

YOURLS是一组PHP脚本，允许您运行自己的URL缩短器。您将完全控制自己的数据，获得详细的统计信息、分析报告，支持插件扩展等。它是免费的。

https://github.com/YOURLS/YOURLS

如何使用本镜像

启动amd64/yourls服务器实例

bash
docker run \
    --name some-yourls \
    --detach \
    --network some-network \
    --env YOURLS_SITE="https://example.com" \
    --env YOURLS_USER="example_username" \
    --env YOURLS_PASS="example_password" \
    docker.xuanyuan.run/amd64/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=... \
    docker.xuanyuan.run/amd64/yourls

访问YOURLS管理界面

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

bash
docker run \
    --name some-yourls \
    --detach \
    --network some-network \
    --publish 8080:8080 \
    docker.xuanyuan.run/amd64/yourls

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

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

环境变量

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

YOURLS_SITE

必填项。
YOURLS实例的URL，不带末尾斜杠，小写。

示例：YOURLS_SITE="https://example.com"

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加载密码。例如：

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

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

... 使用https://github.com/docker/compose

yourls的compose.yaml示例：

yaml
name: yourls
services:
  yourls:
    image: docker.xuanyuan.run/yourls
    restart: always
    depends_on:
      - mysql
    ports:
      - 8080:8080
    environment:
      YOURLS_DB_PASS: example
      YOURLS_SITE: https://example.com
      YOURLS_USER: example_username
      YOURLS_PASS: example_password
  mysql:
    image: docker.xuanyuan.run/mysql
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: example
      MYSQL_DATABASE: yourls
    volumes:
      - db:/var/lib/mysql
volumes:
  db:

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

添加额外库/扩展

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

如果需要额外的PHP扩展，您需要基于此镜像创建自己的镜像。https://github.com/docker-library/docs/blob/master/php/README.md#how-to-install-more-php-extensions解释了如何编译额外的扩展。

包含持久化用户内容

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

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

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

镜像变体

amd64/yourls镜像有多种版本，每种版本设计用于特定场景。

amd64/yourls:<version>

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

amd64/yourls:<version>-fpm

此变体包含https://www.php.net/fpm，这是PHP推荐的FastCGI实现。

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

一些可能有用的资源：

• https://www.php.net/manual/en/install.fpm.configuration.php
• https://gist.github.com/md5/d9206eacb5a0ff5d6be0
• Pascal Landau的详细文章
• https://stackoverflow.com/q/29905953/433558
• https://wiki.apache.org/httpd/PHPFPMWordpress

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

许可

查看此镜像中包含的软件的https://github.com/YOURLS/YOURLS/blob/master/LICENSE。

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

一些能够自动检测到的额外许可信息可能位于https://github.com/docker-library/repo-info/tree/master/repos/yourls中。

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