wp-juggler-client/README.md

93 lines
5.2 KiB
Markdown
Raw Permalink Normal View History

2024-08-15 16:22:08 +02:00
# WP Juggler Client #
2024-10-08 11:09:40 +02:00
> [!IMPORTANT]
2024-10-08 11:39:25 +02:00
> This repository hosts WP Juggler Client plugin. For WP Juggler [Getting Started Guide](https://github.com/boldthemes/wp-juggler-server/?tab=readme-ov-file#getting-started-guide) or WP Juggler Server plugin, visit this repository: [WP Juggler Server plugin](https://github.com/boldthemes/wp-juggler-server)
2024-10-08 11:09:40 +02:00
WP Juggler is your ultimate solution for effectively managing an unlimited portfolio of WordPress sites from a single, intuitive dashboard.
WP Juggler helps you to enhance your operational efficiency, ensure your sites stay current with updates, and reclaim precious time to focus on more impactful projects.
Being an open-source and completely free tool, WP Juggler is designed to revolutionize your WordPress maintenance experience without costing you a dime.
## How does it work - Main concepts ##
WP Juggler has two components:
- [WP Juggler Server plugin](https://github.com/boldthemes/wp-juggler-server)
2024-10-08 11:30:50 +02:00
- WP Juggler Client plugin - This repository
2024-10-08 11:09:40 +02:00
## Network setup - as easy as one, two, three ##
You can setup your WP Juggler Network in three simple steps:
2024-10-08 11:30:50 +02:00
1. Kickstart the process by installing the [WP Juggler Server plugin](https://github.com/boldthemes/wp-juggler-server) on one of your WordPress sites
2024-10-08 11:09:40 +02:00
2. Install WP Juggler Client plugins on sites you want to control and manage
3. Register and activate your sites on your server with a single mouse click
2024-10-17 15:42:36 +02:00
### Complete User Documentation ###
You can find the complete User Documentation on this link: [https://documentation.bold-themes.com/wp-juggler/](https://documentation.bold-themes.com/wp-juggler/) but you can also find the Getting Started intructions below.
2024-10-08 11:09:40 +02:00
## Getting Started Guide ##
### Install plugins ###
1. Download **wp-juggler-server.zip** file from the [latest release](https://github.com/boldthemes/wp-juggler-server/releases/latest) of **WP Juggler Server** plugin.
2. Install and Activate WP Juggler Server plugin on one of your WordPress sites. This site will serve as your control panel.
3. Download **wp-juggler-client.zip** file from the [latest release](https://github.com/boldthemes/wp-juggler-client/releases/latest) of **WP Juggler Client** plugin.
4. Install and Activate WP Juggler Client plugin on WordPress sites you want to monitor and manage remotely.
### Add new site ###
1. Navigate to **WP Juggler > Sites** in your server's wp-admin and click **Add New**
2. Enter the site name as title, enter the site url.
3. Click **Assign Users** and add the users who will be able to manage the added site (add your user for start).
4. Click **Save** and copy API Key to clipboard
### Activate new site ###
1. Navigate to **WP Juggler** screen in your client site's wp-admin and enter bith API Key and server's url
2024-10-10 16:39:42 +02:00
2. Click **Save Settings**. You will should see the message that your site is successfully activated
3. If the activation fails and the Auth Header Test Row also says "Failed", do as instructed in the section [Enable PHP HTTP Authorization Header](https://github.com/boldthemes/wp-juggler-client?tab=readme-ov-file#enable-php-http-authorization-header)
2024-10-08 11:09:40 +02:00
2024-10-08 11:54:51 +02:00
![Screenshot of WP Juggler Site Edit Screen](https://bold-themes.com/wp-content/wp-juggler-assets/wp-juggler-client.png)
2024-10-08 11:09:40 +02:00
### Fetch your first data ###
1. Navigate to **WP Juggler > Control Panel** in your server's wp-admin and your newly activated site should appear in the list.
2. Click the arrow at the end of its row to expand the panel and click **Refresh All Site Data**
3. Once the refresh finishes you will be able to see the summary of the data retrieved from your site.
4. Explore the available info by clicking buttons in the expansion panel
### Enable one-click login to wp-admin ###
1. Navigate to **WP Juggler > Sites** in your server's wp-admin and edit the desired site.
2. Check **Automatic Login**, enter **Remote Login Username** (username of the user you are going to log in on the target site) and click **Save**
3. On your client site, edit the User's profile and check **Enable auto login for this user**.
4. We are all set. You can test the login by first logging out of the client site's wp-admin.
2024-10-08 11:35:28 +02:00
4. Lastly, go to your control panel and click **wp-admin** button in your site's row. You should be automatically logged in as chosen user.
2024-10-10 16:38:00 +02:00
### Enable PHP HTTP Authorization Header ###
> [!Note]
> This section describes the actions that need to be taken if the Auth Header Test says Failed either on Server or Client side
#### Shared Hosts ####
Most shared hosts have disabled the HTTP Authorization Header by default.
To enable this option you'll need to edit your .htaccess file by adding the following:
```
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
```
just after
```
RewriteEngine on
```
#### WPEngine ####
To enable this option you'll need to edit your .htaccess file by adding the following (see #1):
```
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
```
2024-10-08 11:35:28 +02:00
## ToDo List ##
2024-10-08 11:54:51 +02:00
If you have a feature proposal or an idea on how to make WP Juggler better and more useful, please use [Issues section](https://github.com/boldthemes/wp-juggler-server/issues). We will be glad to review them and add them to [the list](https://github.com/boldthemes/wp-juggler-server/?tab=readme-ov-file#todo-list).