– Plugins

Jb5: Overview

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

In this section, you can create and manage your Repositories, view and install Available Plugins, and manage Installed Plugins.

Installed Plugins

In the Installed Plugins tab, you can view and manage all installed plugins in JetBackup.

Plugin actions:

Enable Plugin

Click on "Enable Plugin" to toggle between enabling and disabling your plugins.

Uninstall Plugin

Click on "Uninstall Plugin" to permanently remove your plugins. Make sure that the plugin is not in use in order to uninstall it.

Available Plugins

In the Available Packages tab, you can view and intsall all available plugins from your repositories.

Plugin Type

Available Plguins

Destination Plugins

Plugins

✔️ SSH

✔️ S3 Compatible

Notification Plugins

Plugins

✔️ Slack	✔️ Telegram
✔️ Syslog

Addon Plugins

Plugins

✔️ Manage Databases*

✔️ JBMC Backward Compatible

* The Manage Databases Plugin is only available on JetBackup 5 for Linux.

Installed plugins are updated automatically via the JetBackup 5 Automated Task. There is no way to disable the auto-updates specifically for plugins as this helps ensure that any changes to the Base JetBackup version that may affect plugin functionality and/or features are up-to-date, and vice versa.

Quick actions:

Install

Install the selected available plugin.

Manage Plugin

Conveniently navigate to the selected plugin's interface.

Uninstall Plugin

Click on "Uninstall Plugin" to permanently remove your plugins. Make sure that the plugin is not in use in order to uninstall it.

Repositories

In the Repositories tab, you can add and manage Repositories that contains JetBackup plugins.

Available Repository actions:

Manage Repository

Click on "Manage Repository" to modify your repository configuration.

Reload Repository

Click on "Reload Repository"" to manually load your repository.

Delete Repository

Click on "Delete Repository" to remove your repository permanently. Make sure that no plugins are installed from the repository in order to delete it.

Create New Repository

To create a new repository, click on "+ Create New Repository".

Example configuration page for a repository:

Repository Name

Specify a unique name for your repository. This will be used internally for your convenience

Repository URL

Specify the URL for the repository where JetBackup will fetch available packages.

Jb5: Notification Plugins

Mon, 01 Jan 0001 00:00:00 +0000

On top of email notifications, you also have the option to install and activate additional notification plugins to integrate with JetBackup, allowing you to send JetBackup notifications via other third-party messaging applications. Below is a list of notification plugins available by default and instructions on how to setup each.

NOTE: You can download jetbackup-eddie-512x512.png to use as an icon for notification integrations, if supported by the integration.

Natively Supported Notification Plugins:

Slack

Create a Slack App

Visit https://api.slack.com/apps and sign-in to your Slack Workspace to create a new app. Specify the name for your app and choose the Slack Workspace where the notification will be sent.

Under the "Features" section, click on "OAuth & Permissions" .

Scroll down to "Scopes: Bot Token Scopes", click on "Add an OAuth Scope" and apply the following permissions:

channles:read
channels:join
chat:write
groups:read

Click on "Install to Workspace" then authorize the permissions you have specified for the app.

Slack will then generate a "Bot User OAuth Access Token". Take note of this token as it will be required to authorize the Slack Plugin in JetBackup.

Private Slack Channels

If the notifications will be going to a private channel, there is one additional step to take in the Slack application.

Go into the channel's details.
Click on the Integrations tab.
Under the Apps box, click "Add an App".

Locate and add the app you created on the Slack API site.

Install and Activate the Slack Plugin

Once you have your Slack App configured, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

On the Slack Notification Plugin, click "Install" then hit "Activate"
On the Slack Notification Integration window, configure the following available options:
- Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
- Specify the Slack Channel Name you would like to receive the JetBackup notifications to.
- Enter the Bot User OAuth Access Token generated in your Slack App then hit "Enable".

JetBackup will then attempt to verify that the Slack Plugin is properly configured by sending a notification to the channel you specified on the plugin, and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Slack.

Syslog

Syslog is used for logging and tracking system messages in the Linux environment. This service constitutes the system log daemon (syslogd), where any program can do its logging in addition to kernel messages.

To Enable this plugin, navigate to Notification Settings (Settings > Notification). On the Syslog Notification Plugin, click "Install" then hit "Activate"

On the Slack Notification Integration window, configure the Notification Alert Levels and the frequency you would like to send your notifications to Slack then hit "Enable". For more information about alert types, please visit Alerts.

Once successfully activated, JetBackup will now be able to send notifications to /var/log/messages via syslog.

Configure a JetBackup Telegram Bot

Open your Telegram app and search for the user @BotFather. You can verify the correct user by looking for the blue checkmark next to the user's name.

Start a chat with the @BotFather and use the following command to begin the Create Bot Wizard: /newbot
- Insert the name for your bot.
- Insert the username for your bot.

NOTE: The username must be globally unique within Telegram. Per the Telegram documentation, Bot Names are publicly searchable and must be able to receive all messages, but not necessarily respond to them. Users that simply start a chat after it's already been configured or add the bot to a group will be unable to view the previous chat history. Alerts will only be sent to the configured chat ID set when creating the Notification Integration. For more information, please click here.

Once complete you should receive an HTTP API Token for your bot. Keep this token somewhere safe as it will be used to verify your bot.

NOTE: You may need to send a few messages in your new chat with the Telegram bot to update the bot data. Otherwise the activation method in the next step may fail. You can check the status of your Telegram bot by visiting [https://api.telegram.org/bot{HTTP_API_TOKEN}/getUpdates]{.title-ref} in your browser. There should be at least one entry of "chat": {"id"}.

Install and Activate the Telegram Plugin

Once you have your Telegram Bot configured and have the Bot API Token, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

On the Telegram Notification Plugin, click "Install" then hit "Activate"
On the Telegram Notification Integration window, configure the following available options:
- Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
- Enter the Bot Token generated in your Telegram APP then hit "Enable".

JetBackup will then attempt to verify that the Slack Plugin is properly configured by sending a notification to the chat you started with your bot and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Telegram.

Microsoft Teams

Register a Teams Apps with Microsoft Entra ID on Microsoft Graph

Visit https://portal.azure.com/#home and sign in with your Microsoft Account to create and register a new app for Microsoft Teams.
Navigate to "Microsoft Entra ID" by either clicking on the “View” button under the “Manage Microsoft Entra ID” at the home screen, or clicking “Microsoft Entra ID” at the expandable navigation bar on the left-hand side.

Once you’re in the “Microsoft Entra ID” page, navigate to “App registrations” and click on “+ New Registration”

Once on the App Registration page, fill in the following items:
- Name: the name that will be displayed when JetBackup sends notifications to Teams.
- Supported account types: Choose which account types can access your app.
  
  a. Accounts in this organizational directory only All user and guest accounts in your directory can use your application or API.
  b. Accounts in any organizational directory (Any Azure AD directory - Multitenant) All users with a work or school account from Microsoft can use your application or API. This includes schools and businesses that use Office 365.
  c. Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox All users with a work or school, or personal Microsoft account) can use your application or API. It includes schools and businesses that use Office 365 as well as personal accounts that are used to sign in to services like Xbox and Skype.
  
  Please use the account type that is most appropriate for your needs. For this example, we used option 3 to give the most open access for demo purposes.
- Redirect URI (required): the JetBackup notification plugin requires the Teams notification application to reach out to our Microsoft Teams authenticator. Select “Web” under application and set the following URI: https://auth.jetbackup.com/msteams/
- Click on Register

Once registered, you will be redirected back to your Application’s Overview page. Here you will be able to get an overview of your apps’ display name, Application ID, Directory ID, and other information that will be needed to connect your app to the JetBackup Notification plugin.

The next step is to set the required API permission to allow the JetBackup Notification plugin to communicate with your Teams App. From your application’s Overview Page, navigate to “API permissions” > “+ Add a permission”.

The Request API permissions window will pop up. Select “Microsoft Graph” > “Delegated permissions”, enable the following permissions then click “Add permissions”:
- Offline_access (Listed under "OpenId permissions")
- Channel.Create (Listed under "Channel")
- Channel.ReadBasic.All (Listed under "Channel")
- ChannelMessage.Send (Listed under "ChannelMessage")

The next step is to generate a Client Secret that your application will use as identification when requesting a token for authentication. Under the Application page, navigate to “Certificates & secrets” > “Client secrets” > “+ New client secret”. The “Add a client secret” window will pop up and you will be asked to specify a Description and how long the secret will take to expire then click Add.

Once added, take note of the Value and Secret ID. Please also note that you would need to generate a new client secret once it expires and update the Value on your JetBackup Teams Notification Plugin.

The next step is to provide admin consent to your application. First, navigate back to the “Azure Activity Directory” page then select “Enterprise applications” at the navigation bar. On the Enterprise applications page, you should see the app you just created. Click on your app then navigate to the “Permissions” page under Security. Click on the Grant admin consent button for your user to your application, select the appropriate account then click accept.

Once done, the application is ready to be set up in JetBackup 5.

Install and Activate the Microsoft Teams Plugin

Once you have your Microsoft Teams App configured, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).
On the Teams Notification Plugin, click "Install" then hit "Activate".
On the Teams Notification Integration window, configure the following available options:
- Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts
You will then be asked to specify the following items:
- Teams ID (Group ID): Can be found in the following interface: https://admin.teams.microsoft.com/teams/manage copy and use your Group ID.

-   Channel Name: The channel under your Team that you would like to receive notifications to
-   Client ID - Can be found on your Microsoft AD application Overview Page (Application (client ID))
-   Client Secret (Value generated on [Step 8 - Client Secret](#microsoft-teams))
-   Tenant ID (Can be found on your Microsoft AD Home Page)
-   Authorization Code (Once everything above is specified, click on "Get Authorization Code" and the JetBackup Teams Authorization Code Generator will pop up. Copy the code and paste it on this field.)
-   Hit \"**Save**\"

JetBackup will then attempt to verify that the TeamsPlugin is properly configured by sending a notification to the channel you specified on the plugin, and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through your Teams Channel.

Jb5: Addons Plugins

Mon, 01 Jan 0001 00:00:00 +0000

The Addons Plugins are plugins that provide extra functionality to the Core JetBackup features. Our showcase Addon Plugin is the Manage Databases plugin which is only available for JetBackup 5 for Linux installations. This plugin allows you to assign databases to Linux accounts in order to be included in Account Backups.

Natively Supported Addons Plugins:

Manage Databases

Configure Database Credentials

Navigate to JetBackup 5 -> Settings -> Panel to configure the login credentials for your MySQL, PostgreSQL, and/or MongoDB instances.

NOTE: Due to a known issue with MySQL and PHP on Debian/Ubuntu systems, if you are using localhost, you may need to use 127.0.0.1 instead. In order to successfully authenticate MySQL on Ubuntu, you need to ensure that the MySQL superuser used to authenticate only has superuser@127.0.0.1 and does not have superuser@localhost configured.

When establishing a connection to MongoDB, please input "admin" in the "Auth Database" field. This ensures that JetBackup uses the admin database.

You can also assign a Default Databases Backup Account. This account will "own" all Databases and Database users for Account Backups.

Install the Manage Databases Plugin

From the Plugins -> Available Plugins Page, install the Manage Databases Plugin.
After the installation is complete, navigate to the Installed Plugins tab to ensure the Plugin is Visible/Enabled.

Assigning Databases

The Manage Databases plugin will be set to automatically assign databases to accounts by default. Database names must start with username_ in order to be automatically assigned.

You can also change the Settings to manually assign databases to your Accounts.

From the Assign Databases tab, select the supported Database Engine and associated account you want to assign databases too.

If you observe that the Manage Database Plugin is unable to fetch Databases/Database Users, there may be an issue authenticating the Database Engine with the Credentials provided under the Databases Auth Panel Settings.

Please check the following FAQ/Troubleshooting entry for possible PostgreSQL authentication issues.

You will then be taken to the Assign Database for Account screen.
Select from the left hand side which Databases and Database Users you would like to assign to the selected Account.

NOTE: The selection of the "root" account is NOT supported. Instead, Jetbackup 5 recognizes a non-root Linux user as a valid account for assigning the databases and database users that you desire to backup.

After all Databases and Database users have been selected, press save.
Now an Account Backup of the assigned account will include the Databases and Database users it was assigned!

JBMC Backward Compatible

The JBMC Backward Compatible plugin is a supporting plugin for the JetBackup Management Console that allows communication between the registered JetBackup MC Sever and the Local JetBackup 5 Server. Please note, the JetBackup Management Console Register Feature handles the installation/configuraiton of the JBMC Backward Compatible plugin.

The JBMC Backward Compatible plugin page can be used to verify that the local JetBackup 5 Server is registered with a JetBackup Management Console.