Developers

cPanel plugin

What you get

  • Domain list (main, addon, subdomain, parked) grouped by DNS label path, with type, live URL, and preview status
  • Route and SSL status per domain, and a PHP badge that can change that domain’s version
  • WordPress — guided install, admin login via preview URL, optional uninstall
  • One-click and bulk free-slot create — click-based lifetime (1 week by default, down to 1 day, 1 hour or 1 minute on busier destinations); when a preview expires, free renewal
  • One-click and bulk paid-slot create — uses previews from your SkipDNS plan quota
  • Per-link wildcard / multisite and Flexible SSL toggles; expiration and pair-click columns
  • Optional link passwords, apply-all passwords, free-slot renew, delete, and bulk copy (Markdown lists)
  • SkipDNS CLI (link, wp, route, ssl, and php) for server admins and customers over SSH (details below)
  • Settings — BYOK API token and default preview brand domain per account
  • WHM SkipDNS — account overview, preview counts, SSO into each user’s SkipDNS screen in cPanel
  • Paid one-time extensions — optional extra calendar time on expired free-slot links (separate from free renewal; purchase in the plugin UI)
  • Convert eligible free-slot links to paid slots when your plan allows
  • Daily update check — compares installed vs published version and downloads only when newer

Server vs account API token

The host configures a server-wide token in the server config file (readable only by privileged cPanel UAPI—end users never see it). New links use that token by default.

/etc/skipdns/config.json

Customers can add their own token in the plugin UI. Links they create or manage with that token are billed against their SkipDNS account (useful when subscribers bring their own plan). The plugin merges server and account links in one table when both are configured.

One API key can be shared across several servers; watch paid-slot and quota usage on the account.

Installation

Run as root on the cPanel server:

bash <(curl -fsSL https://skipdns.link/skipdns-cpanel-install.sh)

The installer verifies the package checksum and removes its temporary files automatically.

The interactive setup wizard prompts for:

  • Server API token — from your SkipDNS dashboard (saved to the server config file below)
  • Default link type — free slot (limited lifetime) or paid slot (plan quota)
  • Paid-slot expiration (when paid slot is selected) — no expiration, 1 month, 1 week, 1 day, or 1 hour
  • Customer expiration control — allow custom expiration, or server timer with renew-only (default)
  • Default preview domain — platform default or a brand domain from your account
  • Default Flexible SSL for new links (off is recommended; turn on only when previews fail without it)
  • Default link password (optional; leave empty for no password)

Server config file:

/etc/skipdns/config.json

View current settings:

/usr/local/cpanel/bin/skipdns-configure.sh --show

Validate install (config, UI menu, cron, version; no API call):

/usr/local/cpanel/bin/skipdns-configure.sh --check

Change settings (interactive wizard):

/usr/local/cpanel/bin/skipdns-configure.sh

Unattended installation

For automation (Ansible, imaging, bulk deploy), run a single install command as root with the same options as the configure wizard; settings are saved before plugin files are deployed.

From the extracted ZIP:

bash skipdns-cpanel-plugin/skipdns-install.sh \
  --api-token 'YOUR_TOKEN' \
  --link-type free \
  --flexible-ssl no \
  --default-domain auto

With only --api-token, other settings match the interactive wizard defaults: free-slot links, Flexible SSL off, platform default preview domain, no default password.

Unattended install applies recommended WHM tweak settings by default. Pass --skip-tweaks to leave WHM unchanged. Interactive install prompts per tweak; pressing Enter applies the recommended value (Y to enable or disable as listed below).

SkipDNS does not require these tweaks; they help migration previews (domains not live on this server yet, clearer per-domain lists in cPanel). Tweaks already at the target value are skipped.

WHM key Set to Effect
allowunregistereddomains On (1) Users can create new accounts and add domains (and their subdomains) that are not registered with a registrar. Useful for dev/agencies preparing new websites or proposals for leads who do not have a domain yet, and for staging environments that simulate a real top-level domain.
allowremotedomains On (1) Users can add domains whose DNS does not point to your server yet (typical pre-migration; enabled on most hosting companies).
publichtmlsubsonly Off (0) Domains are not forced to stay within public_html. Allows better isolation of the main website from other sites and helps prevent indirect access such as https://main.com/addon.net.
share_docroot_default Off (0) The add-domain screen no longer defaults to a shared document root (parking the new domain over the main). That default is difficult to reverse in practice and often causes confusion. Addon domains added with sharing off can later use the same document root as the main (replicating parking) or another domain (multisite/multitenant setups).

In WHM: Server Configuration » Tweak Settings (search by key). It is the server administrator’s responsibility to understand what these options mean on your servers before applying them.

Re-running install without new options only redeploys plugin files and keeps existing server settings. Use the configure wizard or its command-line flags to change settings without reinstalling files.

SkipDNS CLI

Run skipdns on the server over SSH (installed at /usr/local/bin/skipdns). Root can manage any hosting account; customers manage only their own account, with the same rules as the SkipDNS cPanel screen (including their own API token in Settings).

Top-level groups are link (preview links), wp (WordPress install, cron, flex mu-plugin, admin login), route (whether the live hostname reaches this server), ssl (the HTTPS certificate on the vhost), and php (the PHP version for that domain). Bracketed [cpuser] and [example.com] are optional: the CLI infers the account from your SSH session and the host from your cwd when it is under that vhost’s document root.

Preview links

skipdns [cpuser] link list
skipdns [cpuser] link get [example.com]
skipdns [cpuser] link create [example.com] [brand_domain_id] [old_ip]
skipdns [cpuser] link create-all [brand_domain_id] [old_ip]

skipdns [cpuser] link delete [example.com]
skipdns [cpuser] link delete-all

skipdns [cpuser] link flex get [example.com]
skipdns [cpuser] link flex set on|off [example.com]
skipdns [cpuser] link wc get [example.com]
skipdns [cpuser] link wc set on|off [example.com]
  • link list — live URL → preview URL for each site that has a preview
  • link get — one preview URL; renews expired free-slot links only (does not create a new preview)
  • link create — ensure a preview exists for one domain (root uses the server token; customers follow panel / BYOK rules). Optional trailing old_ip (public IP of the previous host; the destination IP is detected automatically) enables migration preview. On success, stdout prints both preview URLs, for example https://<examplecom>.oldhost.link => https://<examplecom>.skipdns.link. The first URL serves the website from the source (old) server and the second from the destination, so you can always compare both to validate a migration, no matter where the domain currently resolves.
  • link create-all — same as create for every domain on the account; an optional old_ip applies to all links in the run
  • link delete — by live hostname or preview URL
  • link delete-all — remove all previews on the account
  • link flex — get or set on|off for the preview link’s Flexible SSL toggle; not the same as wp flex (mu-plugin)
  • link wc — get or set on|off for wildcard / multisite routing on the preview link

WordPress

skipdns [cpuser] wp install [example.com]
skipdns [cpuser] wp uninstall [example.com]
skipdns [cpuser] wp login [example.com]

skipdns [cpuser] wp cron get [example.com]
skipdns [cpuser] wp cron set virtual|system|both|none [example.com]

skipdns [cpuser] wp flex get [example.com]
skipdns [cpuser] wp flex set on|off [example.com]
  • wp cron get — prints virtual, system, both, or none
  • wp cron set — applies the chosen mode; prints the resulting mode on stdout
  • wp flex — get or set on|off for the Flexible SSL mu-plugin (not link flex)

Route

skipdns [cpuser] route check [example.com]
skipdns [cpuser] route status [example.com]
  • route check — prints ok when public DNS or the origin probe shows the hostname routes to this server (the green Route dot). Prints fail otherwise.
  • route status — prints direct, cdn-proxy, cdn-redirect, partial, fail, or unknown

SSL

skipdns [cpuser] ssl check [example.com]
skipdns [cpuser] ssl status [example.com]
skipdns [cpuser] ssl install [example.com]
  • ssl check — prints ok when the HTTPS vhost has a certificate, including a self-signed or expired one. Prints fail when the vhost has none.
  • ssl status — prints trusted, self-signed, expired, expired-self-signed, stored (in the account, not yet on the vhost), missing, or unknown
  • ssl install — installs the stored certificate onto the HTTPS vhost (same action as the SSL column). Prints installed, already, or unavailable. Turns preview Flexible SSL off when the vhost now has a certificate. Does not remove the WordPress mu-plugin.

PHP

skipdns [cpuser] php get [example.com]
skipdns [cpuser] php set 8.2 [example.com]
skipdns [cpuser] php set inherit [example.com]
skipdns [cpuser] php revert [example.com]
  • php get — prints the version the PHP badge would select, such as 8.2, ea-php82, or inherit when the domain follows Default.
  • php set — sets that version (8.2, ea-php82, alt-php82, inherit, or default). Without PHP Selector Site Isolation, add --account or --docroot. A .htaccess handler that would still override the new version is removed. --docroot writes a handler instead. The live probe confirms the result and restores the previous setting when the response does not match.
  • php revert — restores the previous setting when a change could not be confirmed.

Run skipdns --help on the server for install flags and the full syntax.

Automatic updates

A daily cron runs the update script. It compares the installed plugin version with the remote release and downloads the ZIP when newer.

/usr/local/cpanel/bin/skipdns-update.sh

Force reinstall:

SKIPDNS_FORCE_UPDATE=1 /usr/local/cpanel/bin/skipdns-update.sh

Update log:

/var/log/skipdns-cpanel-plugin-update.log

Server-wide Flexible SSL (Apache)

SkipDNS discourages Flexible SSL—use it only as a last resort when a preview cannot load over HTTPS any other way. Current cPanel releases typically install a self-signed SSL certificate on new accounts by default, which is enough for HTTPS previews without Flexible SSL in most cases.

If you still need server-wide support—for example legacy servers without auto SSL, or apps that break unless Apache sees HTTPS—add the following to global Apache includes or your vhost template so customers do not have to edit each .htaccess:

SetEnvIf X-Forwarded-Proto https HTTPS=on
SetEnvIf X-Forwarded-Proto https SERVER_PORT=443

SkipDNS sends X-Forwarded-Proto and X-SkipDNS-Proto; prefer the forwarded-proto form when you can so the same rules also cover Cloudflare Flexible SSL, load balancers, and other reverse proxies.

Per-account troubleshooting (including .htaccess and app config) is described in Help → HTTPS and blank pages.

Uninstall

Run as root on the cPanel server:

/usr/local/cpanel/bin/skipdns-uninstall.sh

Installed with the plugin (you do not need the ZIP package on disk). Removes plugin UI, scheduled updates, and related server components.

Optional manual cleanup (server config is left in place):

/etc/skipdns/