Skip to content

Use the WordPress tools

The Tools group on a hosting’s WordPress tab holds three settings you reach for now and then: Debug, Redis object cache and Admin password. Each row’s summary shows its current state before you open it. The other rows of the group are covered in Create a staging site and push it to production and Repair or reinstall WordPress.

  • WordPress is installed on the hosting and it is a PHP hosting.
  • You hold the Manage WordPress (plugins, staging, …) permission for the hosting.
  • For Redis, redis-server is installed and running on the node that owns the hosting. Check Service health in the sidebar.
  1. Open Hostings in the sidebar, click the hosting, open the WordPress tab, then open Tools and Debug. The summary reads WP_DEBUG on or WP_DEBUG off.
  2. Set the switches:
    • Enable WP_DEBUG: the master switch.
    • Log to wp-content/debug.log: write errors to that file. Hyperion marks this as recommended.
    • Display errors on the page: show errors to visitors. Never use it on a live site, because it exposes file paths and SQL.
  3. Click Apply debug settings. Hyperion writes WP_DEBUG, WP_DEBUG_LOG and WP_DEBUG_DISPLAY into wp-config.php.
  4. When debug.log has content, the row shows its size (read at the last scheduler tick) and a Truncate debug.log button. Click it to empty the file.
  5. Switch Enable WP_DEBUG off again when you are done.
  1. Open Tools, then Redis object cache. The summary reads off, enabled or plugin missing.
  2. Click Enable Redis. Hyperion creates a Redis user for this site with access to one numbered Redis database on the local server, stores its generated password, and writes the WP_REDIS_* constants into wp-config.php (host 127.0.0.1, port 6379, key prefix h<n>_). The row then shows the DB slot number and whether a Password is set.
  3. If the row says “Redis is wired up, but nothing is using it yet”, click Install & activate Redis Object Cache. WordPress only uses Redis once that plugin is active.
  4. To change the password, click Rotate password. Hyperion generates a new one and updates both Redis and wp-config.php.
  5. To switch it off, click Disable Redis and confirm. Hyperion first parks wp-content/object-cache.php as object-cache.php.hyperion-disabled, removes the WP_REDIS_* constants, deletes the site’s Redis user and clears the stored password. Cached items are lost, which is safe because they are only cache.

Each node has 16 Redis database slots, one per site that uses Redis.

  1. Open Tools, then Admin password.
  2. In WordPress user, enter the login (the field starts as admin).
  3. In New password, enter at least 8 characters, or click Generate and copy the result.
  4. Click Reset password and confirm with Reset password.

The password is set with wp-cli. Browser sessions that are already signed in stay signed in.

From a shell, hctl wp reset-password example.com admin does the same and prints a generated password once unless you pass --password-stdin.

  • Debug: the Debug summary reads WP_DEBUG on or WP_DEBUG off, and the page shows “Settings saved”. With logging on, wp-content/debug.log appears in the hosting’s Files.
  • Redis: the summary reads enabled, and the DB slot shows a number. plugin missing means the constants are written but the Redis Object Cache plugin is not installed yet.
  • Password: sign in at https://<domain>/wp-login.php with the new password.
  • “redis-server is not installed or not active on this node. Install + start it from /services first.”: install and start Redis on the node (Service health in the sidebar), then enable it again.
  • “no free Redis DB slot (all 16 in use)”: all 16 slots on the node are taken. Click Disable Redis on a site that does not need it, or move the site to another node.
  • “Redis cache requires a PHP hosting” or “WP_DEBUG toggle requires a PHP hosting”: the hosting is not a PHP hosting.
  • A Redis outage stops the site: park the drop-in as described in Repair a broken WordPress site.
  • “new password must be at least 8 characters”: enter a longer password.
  • “hosting must be active to reset WP password”: resume the hosting first.