参考资料

Yourls 官方文档：Welcome to YOURLS | YOURLS

Github 仓库：YOURLS/YOURLS: 🔗 The de facto standard self hosted URL shortener in PHP

部署过程

0. 创建新数据库，也可用现有数据库

1. 下载最新的Releases · YOURLS/YOURLS

2. 解压下载的Releases · YOURLS/YOURLS

3. 复制/user目录下的config-sample.php 并重命名为config.php

以下是config-sample.php中的内容进行解释

---

define( 'YOURLS_DB_USER', 'your db user name' );

• 设置数据库用户名。

define( 'YOURLS_DB_PASS', 'your db password' );

• 设置数据库密码。

define( 'YOURLS_DB_NAME', 'yourls' );

• 设置数据库名称，要求只包含小写字母、数字和下划线。

define( 'YOURLS_DB_HOST', 'localhost' );

• 设置数据库主机名，通常为 localhost，如果使用非标准端口，可以写成 主机名:端口号。

define( 'YOURLS_DB_PREFIX', 'yourls_' );

• 设置数据库表前缀。YOURLS 会使用它来创建数据库表（例如：yourls_url, yourls_options 等）。

---

define( 'YOURLS_SITE', 'http://your-own-domain-here.com' );

• 设置 YOURLS 安装的网址，不带尾部斜杠，且保持一致（不能时而带 www. 时而不带）。

define( 'YOURLS_LANG', '' );

• 设置使用的语言（.mo 文件）。默认英文，可从 YOURLS 语言包页面 下载所需语言，需要将.mo文件和.po文件都下载下来放到/user/languages目录下，比如需要中文则需要将这部分改成define( 'YOURLS_LANG', 'zh_CN' );。

define( 'YOURLS_UNIQUE_URLS', true );

• true：同一个长网址只能生成一个短网址。
• false：允许同一个长网址生成多个不同的短链接。

define( 'YOURLS_PRIVATE', true );

• true：后台管理需要用户名密码登录。
• false：不需要登录（适合内网使用或测试）。

define( 'YOURLS_COOKIEKEY', 'modify this text with something random' );

• 用于加密登录 cookies 的密钥，建议设置为一个长且随机的字符串，可以从 随机字符串生成 复制随机字符串。

---

$yourls_user_passwords = [
    'username' => 'password',
    // 'username2' => 'password2',
];

• 设置允许登录后台的用户名和密码。可以配置多个账号。
• 密码可以是明文（YOURLS 会自动加密）或加密后的字符串。

---

define( 'YOURLS_URL_CONVERT', 36 );

• 设置短网址关键字生成方式：
  • 36：使用小写字母和数字。
  • 62：使用大小写字母和数字。

---

define( 'YOURLS_DEBUG', false );

• 是否开启调试模式，开发或提交 Bug 报告时设为 true。

---

$yourls_reserved_URL = [
    'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick',
];

• 设置不允许出现在短链接中的关键词（防止生成不雅或敏感词链接）。

---

/*
 ** Personal settings would go after here.
 */

• 如果你还有其他定制化的配置，可以在此之后添加。

4. 根据所需更改config.php中的内容

5. 配置nginx，在宝塔环境下，要在网站配置文件合适的位置加上如下命令，否则可以出错，代码添加位置请参考图片

    # Rewrites
    location / {
      try_files $uri $uri/ /yourls-loader.php$is_args$args;
      # if YOURLS is installed in a subdirectory, change the path
      # to yourls-loader.php accordingly, eg
      # try_files $uri $uri/ /subdir/yourls-loader.php$is_args$args;
    }
  
    # PHP engine
    location ~ \.php$ {
      #include fastcgi.conf;
      # OR
      # #include fastcgi_params;
  
      fastcgi_index index.php;
  
      # MUST BE EDITED TO REFLECT YOUR CONFIGURATION
      fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
    }

php8.2-fpm.sock中的php8.2要根据实际的php版本做出更改，如果php版本是php8.1，则应该为php8.1-fpm.sock

6. 访问http://your-own-domain-here.com/admin进行安装和使用，必须加上/admin，不加访问不到页面