Skip to content

BountySite Wordpress Plugin

Introduction

BountySite plugin allows BountySite users to manage their backups from within wordpress. This is done by making REST API to BountySite Backup API. Before using plugin, API ACLs(whitelisting of IPs) have to configured on BountySite control panel for security purposes. The plugin is useful post configuring backups on BountySite control panel. BountySite uses FTP/SFTP/FTPS mode to transfer data, as configured within BountySite control panel. Configure your backups using BountySite Control Panel first using this link.

BountySite plugin allows wordpress users to manage the following features:-

  • Schedule Backup
  • View Backup History of Code(web files) and database
  • View Website change history
  • Schedule a restore

Download

You can download and install BountySite plugin directly from Wordpress plugins by searching for plugin name BountySite. Alternatively, you can also download BountySite Wordpress plugin from this link.

You can also download directly on the server using wget.

 $ wget -O wordpress-bountysite-plugin.zip https://www.bountysite.com/downloads/wordpress-bountysite-plugin.zip

Installing

Upload the downloaded zip file to your web server or extract under local website copy and upload via FTP. The following shows example using ssh access.

  • Extract the zip file under wp-content/plugins. within wordpress installation folder

    ~ $ cd www/wp-content/plugins                    
    plugins $ unzip   ~/wordpress-bountysite-plugin.zip 
    Archive:  ~/wordpress-bountysite-plugin.zip
       creating: bountysite/
      inflating: bountysite/bountysite.php  
       creating: bountysite/admin/
       creating: bountysite/admin/images/
      inflating: bountysite/admin/images/bountysite_biglogo.svg  
      inflating: bountysite/admin/images/bountysite_menu.svg  
       creating: bountysite/admin/js/
      inflating: bountysite/admin/js/bootstrap.min.js  
       creating: bountysite/admin/css/
      inflating: bountysite/admin/css/bootstrap.min.css  
      inflating: bountysite/readme.txt   
       creating: bountysite/includes/
      inflating: bountysite/includes/class-Bountysite-Revisions.php  
      inflating: bountysite/includes/class-Bountysite-Settings.php  
      inflating: bountysite/includes/class-Bountysite.php  
      inflating: bountysite/includes/class-Bountysite-History.php  
       creating: bountysite/assets/
      inflating: bountysite/assets/screenshot-1.png  
      inflating: bountysite/assets/screenshot-3.png  
      inflating: bountysite/assets/icon-256x256.png  
      inflating: bountysite/assets/screenshot-2.png  
      inflating: bountysite/assets/icon-128x128.png  
     extracting: bountysite/admin/images/bountysite_menu.png  
      inflating: bountysite/assets/banner-772x250.png  
    

  • That is all! You have successfully installed BountySite plugin

Configuring

Now, you have to provide API URL and Key to the plugin to be able to communicate to BountySite Backup API and get started.

Get API Key and URL details

Login to your BountySite control panel. On top navigation bar, click on second last button, with tooltip "Settings". Then choose, Get API Key

Backup API Key Menu

Top menu API Key

Backup API Key Page

Manage API Key ACL

Manage API Key ACL page:-

  • a : Click on Copy button to copy API Host/URL to your clipboard, for API URL
  • b : Click on Copy button to copy API Key to your clipboard, for API Key
  • c : By default API is blocked for public access. To allow your host to make API calls, add your public internet IPaddress in CIDR format(x.x.x.x/32 or range x.x.x.x/28). You can give multiple IPs separated by commas.

Copy credentials to Wordpress BountySite page

Login to your wordpress admin panel, and go to BountySite menu. Wordpress BountySite Plugin Settings

Wordpress BountySite Settings page

  • Paste the credentials from BountySite control panel API Key page.
  • History show limit is the number of latest entries you want to see in the plugin.
  • On submitting the form, the plugin makes a REST call to BountySite Backup API and validates the API URL and key, with respect to your sitename(which is automatically fetched from wordpress installation). On confirmation, the values are stored in Wordpress database. The following message is printed.

Wordpress settings saved

Wordpress BountySite Settings page

Troubleshooting

On error, you may get the following notification:-

API Key and sitename mismatch

On BountySite control panel, check if your sitename is the same as the one with wordpress bountysite plugin installation. Settings error

Unauthorized Host

Check if you added the primary public IP Address of your web hosting server. This IP is used for outbound calls. It is possible that your web host may have multiple IPs. Contact your hosting provider to find the primary public IP. Add the IP to API Key page as x.x.x.x/32. Unauthorized message

Verify if you have filled all the input fields in the form.

Schedule a backup

On wordpress admin page, using menu, go to BountySite > BountySite Backup History, and click on RunBackupNow. The backup is scheduled for web files and databases as configured in BountySite control panel. The mode of transfer is as configured in control panel.

  • Menu : BountySite -> BountySite Backup History
  • Top right side, button, named "RunBackupNow" to schedule a backup
  • Code(web files) and database is shceduled for download via mode(FTP/SFTP/SFTP) configured in BountySite control panel
  • BountySite backup history page will confirm backup post completion of the backup process

Schedule Backup now

Wordpress BountySite Schedule Backup job

Get Backup History

View Backup History of Code(web files) and database

  • From Wordpress admin panel
  • Menu : BountySite -> BountySite Backup History
  • Note the tabs named Code and Database
  • Tab Code shows web file backup history
  • Tab database show database file backup history
  • Bytes backed shows total bytes backed
  • On incremental backup Bytes backed shows differential bytes of data transfered
  • Start time column shows when the backup was started post backup queueing
  • Time taken shows the total time taken in seconds from start to end of backup
  • Commit Time shows the time in GMT when the file was acutally commited, which is used as reference for restores

Backup History

Wordpress BountySite Backup History

Get Site Revisions

View Website change history

  • Fom Wordpress admin panel
  • Menu : BountySite -> BountySite Backup Revisions
  • Revisions page shows history of site changes. This is different from Backup History, cause every backup may not have a change in Code(web files) or database.
  • (a) Note the tabs named Code and Database, for web files and db file respectively

Backup revisions

Wordpress BountySite Backup Revisions

Restore

Schedule a restore

  • Fom Wordpress admin panel
  • Menu : BountySite -> BountySite Backup Revisions
  • Restore Code or Database, by choosing corresponding tab
  • Click on restore button corresponding to the commit time(snapshot), you want to restore to. Marked as (b) in below image.

Schedule Restore

Wordpress BountySite Restore