RRZE Updater

RRZE Updater is a WordPress plugin for synchronizing plugins and themes with the corresponding GitHub or GitLab repositories. RRZE Updater offers the following features:

• Installation of WordPress plugins from a GitHub or GitLab repository
• Installation of WordPress themes from a GitHub or GitLab repository
• Configurable selection of branch, repositories, and service
• Updating plugins via the plugin/theme overview when there are changes in the branch

Contributors

• RRZE-Webteam, https://www.rrze.fau.de

Copyright

GNU General Public License (GPL) Version 3

Documentation

Public documentation at:

• https://www.wp.rrze.fau.de

Feedback

• Issues und Feedback: https://github.com/RRZE-Webteam/rrze-updater/issues
• Kontakt: webmaster@rrze.fau.de

Requirements

• WordPress ab 6.8
• PHP ab 8.3
• WordPress Multisite

Installation

• Download the current RRZE Updater repository as a .zip file.
• Log in to WordPress
• Navigate to Dashboard, then Plugins, then Install Plugin.
• Activate RRZE Updater from the list of installed plugins.

Select a Service

To select a service, proceed as follows:

• Navigate to Dashboard, then Repositories, then Services.
• The service overview opens.
• Click "Add New".
• Select "GitHub" or "GitLab" from the dropdown for Service.
• Enter the name of the group/user. The group name is visible in the URL when opening the repository in the browser.
• Add a token for access if necessary.
• Confirm by clicking "Add New Service".

Add a Repository (Theme or Plugin)

The steps are the same for themes.

• Navigate to Dashboard, then Repositories, then Plugins.
• The plugin overview opens.
• Click "Install".
• Select the correct service.
• Enter the repository name used in GitLab or GitHub.
• Change the branch to the name of the desired branch.
• Choose whether to use commits or tags for checking for updates.
• (Optional) Specify a different plugin or theme folder.
• (Optional) Choose whether existing plugin files should be overwritten.
• Confirm by clicking "Install Plugin".

Check a Plugin or Theme for Updates

RRZE Updater automatically checks for new updates. To manually check for new updates, proceed as follows:

• Navigate to Dashboard, then Repositories, then Plugins/Themes.
• Select the desired repository from the overview via "Edit".
• Click "Check for Updates".
• The pending update will then appear in the WordPress plugin or theme overview.

Report Errors

Errors can be logged as issues in GitLab. Alternatively, issues and inquiries can be sent to webmaster@fau.de with the subject "RRZE Updater Plugin".