Onion Service by Adam Szokol
A focused plugin designed to enable Onion Service & Mapping support for your WordPress site.
Plugin info
Maintenance & Compatibility
Maintenance score
Actively maintained • Last updated 42 days ago
Is Onion Service by Adam Szokol abandoned?
Likely maintained (last update 42 days ago).
Compatibility
Similar & Alternatives
Explore plugins with similar tags, and compare key metrics like downloads, ratings, updates, support, and WP/PHP compatibility.
Description
The Onion Service by Adam Szokol plugin provides reliable functionality for integrating your WordPress site with the Tor network. It configures your site to handle .onion addresses, which can enhance accessibility and privacy for your visitors using the Tor Browser. This plugin is built to work effectively on both single-site and WordPress Multisite installations.
A core feature is its administrative helper functionality. On activation, the plugin checks for and creates a necessary sunrise.php file for domain mapping support. It also attempts to add the required define( ‘SUNRISE’, true ); constant to your wp-config.php file, which is often the most complex step in the setup process. This modification is only attempted if file permissions allow it.
The settings interface is available only to administrators (or Super Admins on Multisite), allowing you to easily map your .onion domains and manage the service status.
Key Features:
Automatic sunrise.php Creation: Handles the creation and placement of sunrise.php for reliable domain mapping.
Optional wp-config.php Modification: Attempts to safely add the SUNRISE constant to your configuration file, providing a setup assist.
Unified Architecture: Works consistently across single WordPress sites and Multisite networks.
Onion-Location Header: Automatically informs Tor Browser users that a private .onion version of your site is available.
Full Domain Mapping: Assign unique .onion domains to specific sites in your installation.
Service Status Control: Easily disable the onion service and display a custom maintenance message.
Installation
Upload the adamszokol-onion-service folder (or the single adamszokol-onion-service.php file) to the /wp-content/plugins/ directory.
Activate the plugin through the ‘Plugins’ menu in WordPress.
On activation, the plugin will attempt to create /wp-content/sunrise.php and add define( ‘SUNRISE’, true ); to your wp-config.php file.
Go to Settings -> Onion Service (or My Sites -> Network Admin -> Onion Service on Multisite).
If you see any warnings at the top of the settings page, follow the instructions. This usually involves setting file permissions or manually adding a line to wp-config.php if the automatic process failed.
Use the settings page to map your .onion address to your site.
For a standard site, the Site ID is 1.
On Multisite, search for the site you want to map.
Click “Save Settings & Mappings”.
Frequently Asked Questions
Using sunrise.php for all installations creates a common, robust architecture. It is the most reliable way to intercept a request for an .onion domain before WordPress determines the primary site URL, which helps prevent redirect loops and ensures proper site loading. This plugin automates the initial setup.
For security reasons, your wp-config.php file may not be writable by the server. This is normal. Simply open the file and manually add this line before the line that says /* That’s all, stop editing! Happy publishing. */:
define( ‘SUNRISE’, true );
This plugin is designed to be careful. It uses the WordPress Filesystem API and only attempts to write to the file if the SUNRISE constant is confirmed to be missing. If your server permissions don’t allow the write, the plugin will fail safely and instruct you to perform the action manually.
Review feed
Screenshots
Changelog
1.0.1
- Improvement: Enhanced admin site search functionality for smoother domain mapping.
- Tweak: Updated admin interface styling for search results.
- Fix: Minor asset versioning updates.
1.0.0
- Initial release.