You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+27-21Lines changed: 27 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,15 @@ WP Freighter allows you to efficiently run many WordPress sites from a single Wo
7
7
## Features
8
8
9
9
***Lightning Fast Provisioning ⚡** - Spin up new environments in seconds. Only database tables are created or cloned.
10
-
***One-Click Cloning** - Clone your main site or *any* existing stacked site to a new environment. Perfect for staging or testing.
11
-
***Zero-Config Sandbox** - Safely troubleshoot maintenance issues by cloning your live site to a sandbox piggybacked onto your existing installation.
12
10
***Flexible File Isolation** - Choose how your sites share files:
13
-
***Shared:** All sites share plugins, themes, and uploads.
14
-
***Hybrid:** Shared plugins/themes, but unique uploads folder.
15
-
***Dedicated:** Completely unique `wp-content` directory for every site.
11
+
***Shared:** All sites share plugins, themes, and uploads (Single `/wp-content/`).
12
+
***Hybrid:** Shared plugins and themes, but unique uploads for every site (Standardized stack, unique content).
13
+
***Dedicated:** Completely unique `/wp-content/` directory for every site (Full isolation).
14
+
***One-Click Cloning** - Clone your main site or *any* existing stacked site to a new environment. Perfect for staging or testing.
16
15
***Domain Mapping** - Map unique custom domains to specific stacked sites or use the parent domain for easy access.
17
16
***Magic Login** - Generate one-time auto-login links to jump between site dashboards instantly.
17
+
***Zero-Config Sandbox** - Safely troubleshoot maintenance issues by cloning your live site to a sandbox piggybacked onto your existing installation.
18
+
***Secure Context Switching** - Intelligent session management ensures admins can move between sites securely.
18
19
19
20
---
20
21
@@ -25,7 +26,12 @@ WP Freighter allows you to efficiently run many WordPress sites from a single Wo
25
26
3. Activate the plugin.
26
27
4. Navigate to **Tools -> WP Freighter** to configure your environment.
27
28
28
-
> **Note:** WP Freighter must modify your `wp-config.php` file to function. If your host locks this file, you will be provided with a code snippet to add manually.
29
+
### Configuration Note
30
+
WP Freighter attempts to create a bootstrap file at `/wp-content/freighter.php` and modify your `wp-config.php` to function.
31
+
32
+
If your host restricts file permissions:
33
+
1. The plugin will provide the exact code snippets you need.
34
+
2. You will need to manually create the bootstrap file and/or edit `wp-config.php`.
WP Freighter works by dynamically swapping the `$table_prefix`in `wp-config.php`based on the requested domain or a cookie. It offers three distinct file modes to suit your workflow:
128
+
WP Freighter works by dynamically swapping the `$table_prefix`and directory constants based on the requested domain or a secure admin cookie. It offers three distinct file modes to suit your workflow:
123
129
124
-
1.**Shared Mode:**
125
-
* Single `/wp-content/` directory.
126
-
* All sites share the exact same plugins, themes, and media library.
127
-
**Best for:* Multilingual networks or brand variations using the exact same assets.
130
+
### 1. Shared Mode
131
+
***Structure:** Single `/wp-content/` directory.
132
+
***Behavior:** All sites share the exact same plugins, themes, and media library.
133
+
***Best for:** Multilingual networks or brand variations using the exact same assets.
128
134
129
-
2.**Hybrid Mode:**
130
-
*Shared `/plugins/` and `/themes/`.
131
-
* Unique `/uploads/` directory stored in `/content/<id>/uploads/`.
132
-
**Best for:* Agencies managing multiple client sites with a standardized plugin stack but different media.
135
+
### 2. Hybrid Mode
136
+
***Structure:**Shared `/plugins/` and `/themes/`. Unique uploads stored in `/content/<id>/uploads/`.
137
+
***Behavior:** You manage one set of plugins for all sites, but every site has its own media library.
138
+
***Best for:** Agencies managing multiple client sites with a standardized software stack but unique content.
133
139
134
-
3.**Dedicated Mode:**
135
-
* Completely unique `/wp-content/` directory stored in `/content/<id>/`.
136
-
* Each site has its own plugins, themes, and uploads.
137
-
**Best for:* True multi-tenancy, snapshots, and distinct staging environments.
140
+
### 3. Dedicated Mode
141
+
***Structure:** Completely unique `/wp-content/` directory stored in `/content/<id>/`.
142
+
***Behavior:** Each site has its own plugins, themes, and uploads.
143
+
***Best for:** True multi-tenancy, snapshots, and distinct staging environments where you need to test plugin updates in isolation.
138
144
139
145
## Known Limitations ⚠️
140
146
141
-
***`wp-config.php` Access:** The plugin requires write access to `wp-config.php`. If your host prevents this, manual configuration is required.
147
+
***`wp-config.php` Access:** The plugin requires write access to `wp-config.php` and `wp-content/`. If your host prevents this, manual configuration is required.
142
148
***Root Files:** Files in the root directory (like `robots.txt` or `.htaccess`) are shared across all sites.
143
149
***Cron Jobs:** WP-Cron relies on traffic to trigger. For low-traffic stacked sites, consider setting up system cron jobs triggered via WP-CLI.
0 commit comments