Setting Up a Plugin or Theme from GitLab

Installing a plugin or theme from GitLab is super easy with WP Pusher. In this guide you will learn about how to setup GitLab and how to install your first plugin or theme.

Setup

If you want to install and manage a plugin or theme that is in a private repository on GitLab, you will need to obtain an access token for WP Pusher. In order to obtain a token, here are the steps you need to take:

  1. In GitLab, navigate to your profile settings
  2. Navigate to the "Access Tokens" tab
  3. Create a new token with the "api" scope
  4. Copy the token to your clipboard
  5. In WP admin, navigate to the WP Pusher settings and click the GiLab tab
  6. Paste the token in the "GitLab private token" field and click "Save GitLab settings"

If you are using a self-hosted version of GitLab, you will need to save the base URL of your GitLab instance under the GitLab settings in WP Pusher.

Install a plugin or theme

You find the plugin or theme installation screen in WP admin under "WP Pusher" -> "Install Plugin/Theme". While installing the plugin or theme, you have the following options:

  • Repository host: Where the plugin/theme is hosted.
  • Plugin/Theme repository: The repository handle, which is "username/repository-name".
  • Repository branch: (Optional) Specify which branch you want to install your plugin/theme from. Defaults to master if left blank.
  • Repository subdirectory: (Optional) If your plugin/theme lives in a subdirectory of the repository, you can specify the path here.
  • Repository is private: Check this option if your plugin/theme is in a private repository. Requires a license and a GitLab token (see above).
  • Push-to-Deploy: Check this option if you want WP Pusher to automatically update the plugin/theme every time you push new code. For GitLab, this needs to be configured manually.
  • Link installed plugin/theme: If the plugin/theme is already installed and you just want to connect it to WP Pusher, check this option. It is very important that the folder name of the plugin/theme on your web server is the same as the repository name.

Need any help?

If you have any questions about WP Pusher, Git or WordPress, our email is hi@wppusher.com. Don't hesitate shooting us a message! You can also click the little ❤️ in the corner of this page.