-
Notifications
You must be signed in to change notification settings - Fork 682
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4b6ceae
commit c9317e6
Showing
5 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
49 changes: 49 additions & 0 deletions
49
...des/wordpress-configurations/08-installing-updating-from-third-party-sources.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: WordPress Configurations Guide | ||
subtitle: Installing and Updating Plugins from Third-Party Sources | ||
description: Learn how to set up plugins that are set up in external repositories. | ||
contributors: [jazzsequence] | ||
contenttype: [guide] | ||
innav: [false] | ||
categories: [config] | ||
cms: [wordpress] | ||
audience: [development] | ||
product: [--] | ||
integration: [plugins] | ||
tags: [code, plugins] | ||
reviewed: "2024-10-14" | ||
permalink: docs/guides/wordpress-configurations/installing-updating-from-third-party-sources | ||
--- | ||
|
||
This section provide guidance on how to manage plugins that use third party or external repositories including GitHub, Bitbucket, GitLab or self-hosted sources. | ||
|
||
## Using Git Updater | ||
|
||
[Git Updater](https://github.com/afragen/git-updater) is a plugin that allows you to install and update plugins and themes from GitHub, Bitbucket, GitLab, or other self-hosted Git repositories. It provides both a mechanism that plugins can use to suggest updates from a Git-based repository as well as a user interface to install plugins from a Git repository that has not been previously configured to do so. Plugins and themes that use Git Updater can then be updated directly from the WordPress dashboard. | ||
|
||
0. Before you begin, make sure your site is set to SFTP mode either from the Pantheon Dashboard or by using the Terminus `connection:set` command. | ||
```bash | ||
terminus connection:set <site>.<env> sftp | ||
``` | ||
1. Download the latest zip file for the Git Updater plugin from the [GitHub releases page](https://github.com/afragen/git-updater/releases/) or use Terminus to install the plugin from its zip file in the GitHub repository: | ||
```bash | ||
terminus wp <site>.<env> -- plugin install https://github.com/afragen/git-updater/releases/download/12.6.0/git-updater-12.6.0.zip --force | ||
``` | ||
2. Once installed, an option for Git Updater will appear under Settings in your WordPress admin dashboard. Clicking into it for the first time will prompt you to enter a license key or activate the free version. Once you've gone through the initial prompts, you will be presented with the default admin page for Git Updater which includes out-of-the-box support for GitHub-based plugins and themes. | ||
![Git Updater Settings](../../../images/wordpress-configurations/08-git-updater-admin.png) | ||
3. To install a plugin or a theme from a GitHub repository, click on the Install Plugin or Install Theme tab and enter the Plugin URI (in the format `<vendor>/<plugin-name>` e.g. `pantheon-systems/pantheon-hud`), the repository branch (default is `master`) and the remote repository host (either GitHub or a zip file). You can also specify a GitHub Personal Access Token for private GitHub repositories. Then click Install Plugin/Theme. | ||
![Git Updater Install Plugin](../../../images/wordpress-configurations/08-git-updater-install-plugin.png) | ||
|
||
While installing from GitHub is possible, it's not guaranteed that the plugin will be _updated_ from GitHub. Themes and Plugins must have a `GitHub Plugin URI` or `GitHub Theme URI` header in order for the Git Updater to work to update those plugins or themes out of the box. However, it's possible for plugins or themes to receive updates from GitHub or other sources using the Git Updater even if this header is not present by using the Additions tab. | ||
|
||
To add a plugin that gets updates from a Git repository but lacks the GitHub Plugin or Theme URI plugin header line, click on the Additions tab, enter the main plugin file name as the Repository Slug (e.g. `pantheon-hud/pantheon-hud.php`), the repository URI (in the format `<vendor>/<plugin-name>`, e.g. `pantheon-systems/pantheon-hud`), the branch (default is `master`), and whether the plugin or theme should look use a Release Asset (defaults to no release asset). Then click Save Changes. | ||
|
||
![Git Updater Additions](../../../images/wordpress-configurations/08-git-updater-additions.png) | ||
|
||
The Git Updater plugin will now check for updates from the specified repository and branch and will update the plugin or theme as necessary from that source rather than the default behavior. | ||
|
||
### Using Git Updater with non-GitHub Repositories | ||
|
||
Git Updater supports other repository hosts such as BitBucket, GitLab, Gitea and even GitHub Gists. To add support for any of these, go to the API Add-Ons page while your site is in SFTP mode and click Install & Activate for the add-on of your choice. | ||
|
||
![Git Updater API Add-Ons](../../../images/wordpress-configurations/08-git-updater-api-addons.png) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+48 KB
source/images/wordpress-configurations/08-git-updater-install-plugin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.