跳转到正文

快速入门

以 Markdown 格式查看 在 GitHub 上编辑 文档位置 7a44bd6

要求

  • PHP 8.2+
  • WordPress 6.4+
  • MySQL或MariaDB，通过常规WordPress数据库连接
  • 插件激活时，wp-config.php必须可写

安装

使用Composer安装Rudel，然后像普通WordPress插件一样将其激活。

命令行
composer require rudel/rudel
wp plugin activate rudel

Composer会将Rudel安装到vendor/rudel/rudel，除非你的项目将WordPress插件映射到wp-content/plugins（例如使用composer/installers）。插件必须位于插件目录中，wp plugin activate rudel才能找到它。

激活会执行什么

激活会创建Rudel的表、安排每小时清理事件，并在wp-config.php中添加一行引导代码，紧挨着加载wp-settings.php的那一行上方。该行让Rudel能在WordPress完成加载前选择沙盒。Rudel会先写入名为wp-config.php.rudel-backup-{timestamp}的备份副本。

没有单独的安装命令。如果wp-config.php不可写，激活就会失败。停用会移除该行和计划事件。

检查运行时状态：

命令行
wp rudel status

Bootstrap installed应显示yes。

创建沙盒

命令行
wp rudel create --name=alpha --theme=twentytwentyfour

Rudel会输出生成的沙盒 ID，例如alpha-3be7。它会将主机WordPress表克隆到专属表前缀下，将主题复制到沙盒目录，并在主机WordPress数据库中存储记录。以下示例使用alpha-3be7；请改用命令输出的 ID。

在沙盒中使用WP-CLI

命令行
RUDEL_ENVIRONMENT=alpha-3be7 wp option get blogname

没有RUDEL_ENVIRONMENT时，WP-CLI会连接到主机。

将HTTP路由到沙盒

命令行
curl -H 'X-Rudel-Environment: alpha-3be7' http://localhost:8000/

对于浏览器会话，请设置一个值为沙盒 ID 的rudel_environmentCookie。Rudel会读取 Cookie，但不会设置或清除它。删除 Cookie 即可返回主机。

沙盒运行在主机URL上。没有请求头或 Cookie 时，同一个URL会提供主机内容。

后续步骤