Rsync Disk Information Module & Management Plugin by Blesta.Club - Product Overview

Welcome, and thank you for choosing the Rsync Disk Information Module & Rsync Disk Manager Plugin! This guide provides an overview of how they bring rsync.net backup account usage, and the cost of that usage, into Blesta.

Module Capabilities

The Rsync Disk Information Module reads an rsync.net account's usage feed and reports it on the staff and client service pages. It is an informational and billing integration, not a provisioning one: rsync.net exposes no provisioning API here, so backup accounts are created with rsync.net directly and then attached to a Blesta service by staff. From that point on, Blesta shows the account's usage and, with the companion plugin, bills each invoice from those same figures.

Key Features

• Live Usage Reporting: Data uploaded, snapshot usage, total billed storage, idle days, location and geo-redundancy, read straight from the account's usage feed.
• Estimated Next Invoice: The Details tab shows what the storage will cost on the next invoice, calculated exactly the way the Rsync Disk Manager plugin bills it.
• Account Picker for Staff: Staff choose the rsync.net account from a dropdown of the accounts in that server's feed, with a text field as a fallback if the feed is down.
• Usage-Based Invoicing: The Rsync Disk Manager plugin reprices invoice lines from the same feed, so what the client sees is what the client pays.
• Admin & Client Views: Both staff and clients get a Details tab and a service summary panel showing the account and its usage.
• Built-In Demo Mode: Trial every screen against bundled sample data, with no rsync.net account and no feed URL.

Contact Us

If you encounter any issues or have suggestions for improving the module and plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Rsync Disk Information Module & Management Plugin by Blesta.Club - Installation Guide

This guide provides step-by-step instructions for installing the Rsync Disk Information Module and the Rsync Disk Manager Plugin, which together report rsync.net backup account usage in Blesta and bill invoices from those figures.

Prerequisites

1. An rsync.net account usage feed URL: the module does not use an API key. It reads the RSS usage feed URL rsync.net provides for your account. Treat that URL as a password - anyone holding it can read your whole reseller account's usage.
2. Blesta Installation: Ensure Blesta is installed and functional. Version 3.0.0 and newer of the module and plugin require Blesta 6.0 or newer; Blesta 5 installations should use v2.0.0.
3. The PHP simplexml extension: the module refuses to install without it.
4. Staff permissions: your staff account needs Install Module (under Settings > Modules) and Install Plugin (under Settings > Plugins) to install both halves. Grant these on Settings > System > Staff Groups > Manage if your account does not already have full admin access.

Installation Steps

1. Download and Upload the Module & Plugin

1. Download the Rsync Disk Information Module and Rsync Disk Manager Plugin from the client area.
2. Upload the module and plugin to your Blesta directory:

   /var/www/html/blesta/components/modules/rsync_disk/
   /var/www/html/blesta/plugins/rsync_disk_manager/

2. Install the Module

1. Log into your Blesta admin account.
2. Navigate to Settings > Company > Modules.
3. Find Rsync Disk Information under the "Available" tab and click Install.

3. Install the Plugin

1. Navigate to Settings > Company > Plugins.
2. Find Rsync Disk Manager under the "Available" tab and click Install.

4. Configure the Module & Plugin

1. After installation, navigate to Settings > Company > Modules > Installed > Rsync Disk Information > Manage.
2. Click Add Server, then enter a Server Label (a name of your choosing, shown throughout the staff area) and the RSS Feed URL for your rsync.net account. The feed URL is stored encrypted and is never shown back to you: it is not printed on the Manage page, and the field is blank whenever you edit the server. Leave it blank to keep the stored URL, or type a new one to replace it.
3. Leave Mock API Mode unticked for live use. Tick it to trial every screen against bundled sample data, with no rsync.net account at all.
4. Navigate to Settings > Company > Plugins > Rsync Disk Manager > Manage to set the pricing used for invoicing and for the estimated-next-invoice figure shown on the service Details tab.

The Rsync Disk Information Module and Rsync Disk Manager Plugin are now installed and ready for use.

Contact Us

If you encounter any issues or have suggestions for improving the module and plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Rsync Disk Information Module & Management Plugin by Blesta.Club - Update Guide

To ensure you're always using the latest version of the Rsync Disk Information Module and Rsync Disk Manager Plugin, follow these steps to update both in your Blesta installation. The module and the plugin are versioned and released together - always update both.

Steps for Updating the Module & Plugin

1. Download the Latest Version

• Visit the download section of the client area to obtain the latest version of the Rsync Disk Information Module and Rsync Disk Manager Plugin.

2. Upload the Updated Module & Plugin

• Upload the updated files to your Blesta installation directory, replacing the existing files:

   /var/www/html/blesta/components/modules/rsync_disk/
   /var/www/html/blesta/plugins/rsync_disk_manager/

3. Update the Module in Blesta

• Log in to your Blesta admin account.
• Navigate to Settings > Company > Modules.
• Locate the Rsync Disk Information Module in the list and click the "Upgrade" or "Update" button if available.

4. Update the Plugin in Blesta

• Navigate to Settings > Company > Plugins.
• Locate the Rsync Disk Manager Plugin in the list and click the "Upgrade" or "Update" button if available.

5. Check Configuration

• After the update, navigate to Settings > Company > Modules > Rsync Disk Information > Manage and confirm every server row shows a Label.

Upgrading to 3.0.0 - Blesta 6

Version 3.0.0 of both the module and the plugin requires Blesta 6.0 or newer. Do not upload it to a Blesta 5 installation: the staff screens were rebuilt for the Blesta 6 admin interface and no longer render correctly under Blesta 5. If you are still on Blesta 5, stay on v2.0.0 of both until you upgrade Blesta itself, then update the module and plugin together.

Nothing changes in how the module works, what it stores, or what it bills: the server list, the add and edit server forms, the staff Details tab and the service summary on the client profile simply follow the Blesta 6 admin interface now, including its dark mode. The client area is unchanged.

Upgrading to 2.0.0 - what changes on your servers

Servers used to be identified throughout the staff area by their RSS Feed URL. That URL is a credential: anyone holding it can read your whole reseller account's usage. From 2.0.0 it is stored encrypted, it is no longer exposed as a {module.rss_feed} email tag, it is no longer printed on the Manage page, and it is no longer filled back into the server edit form. Servers are identified by a new Server Label instead.

Because the edit form no longer shows it, the RSS Feed field is blank every time you edit a server. Leave it blank and the stored URL is kept; type a new URL only when you actually want to replace it. Keep your own copy of the URL from your rsync.net account - the module will not show it to you again.

The upgrade converts your existing servers automatically: each is given a placeholder label ("Rsync Disk Server 1", and so on) and its stored feed URL is re-saved in encrypted form. Three things to do afterwards:

1. Rename your servers. Open Settings > Company > Modules > Rsync Disk Information > Manage, click Edit on each server, and replace the placeholder label with a name that means something to your staff.
2. If a server shows no label after the update, its automatic conversion did not complete - the conversion re-validates the feed URL, so it is skipped when the feed is temporarily unreachable. Open Edit on that server, enter a label and click Update Server. That also completes the encryption of its stored feed URL.
3. Remove {module.rss_feed} from any email template that used it. The tag no longer resolves; {module.name} is available in its place.

Testing the Update

1. Demo Mode:

   • Add a server with Mock API Mode ticked to exercise every screen against bundled sample data, with no live feed.

2. Service Testing:

   • Open a live service's Details tab and confirm the usage figures and the estimated next invoice still render.

Troubleshooting Update Issues

1. Missing or Incorrect Files:

   • If you experience issues, ensure all files have been uploaded correctly and verify file permissions.

2. Feed Issues:

   • If usage shows as unavailable, re-enter the RSS Feed URL on the server row from your rsync.net account (the form will not show you the stored one). Tools > Logs > Module records each feed read; the feed URL itself is redacted there by design.

3. Compatibility Issues:

   • Confirm that the updated version of the module and plugin is compatible with your current Blesta version: v3.0.0 and newer need Blesta 6.0 or newer, v2.0.0 is the last release for Blesta 5. Check the changelog for any version-related notes.

Contact Us

If you encounter any issues during the update process or have suggestions for improving the module and plugin, please reach out to us. We are dedicated to providing robust updates and value customer feedback.

Rsync Disk Information Module & Management Plugin by Blesta.Club - Usage Guide

Welcome, and thank you for purchasing the Rsync Disk Information Module and Rsync Disk Manager Plugin! This guide walks you through day-to-day use. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

What the module does, and what it does not

The module is informational. rsync.net exposes no provisioning API here, only an account usage feed, so the module does not create, suspend or cancel rsync.net accounts. You create the backup account with rsync.net yourself, then attach it to a Blesta service so that its usage and cost appear in Blesta. The Rsync Disk Manager plugin then reprices each invoice from the same usage figures.

Admin View

1. Registering a feed

   • Navigate to Settings > Company > Modules > Rsync Disk Information > Manage and click Add Server.
   • Give the server a Server Label and paste the RSS Feed URL for your rsync.net account.
   • Add one server per feed. Servers can be grouped if you report on several feeds.

2. Attaching an account to a service

   • Create a package that uses this module, then add or order the service as usual.
   • On the staff Add/Edit Service form, pick the account from the UID dropdown, which lists the accounts found in that server's feed. If the feed is unreachable, the field falls back to a plain text box.
   • The UID can only be set by staff. It is ignored if it arrives from anywhere else, including the client order form.

3. Monitoring usage

   • The service's Details tab shows data uploaded, snapshot usage, total billed storage, idle days, location and geo-redundancy.
   • With the Rsync Disk Manager plugin installed, the same tab also shows the unit price, any geo surcharge, any minimum charge and the estimated next invoice - calculated exactly the way the plugin bills it.
   • The staff and client service summary panels show the account ID, its usage and its location at a glance.

4. Pricing

   • Pricing lives in the plugin: Settings > Company > Plugins > Rsync Disk Manager > Manage.

Client View

• Details tab: clients see their own account's usage and, when the plugin is installed, the estimated cost of their next invoice.
• Service summary: the account ID, its usage and its location appear in the client's service list.

Demo / test mode

Tick Mock API Mode on a server row to serve bundled sample data instead of contacting rsync.net. Every screen works end to end with no account and no feed URL. A service attached while mock mode was on stays on the sample data even if you untick it later, so a demo service can never report against a live account.

Troubleshooting Common Issues

1. "Usage information is temporarily unavailable"

   • The feed could not be fetched or parsed. Re-enter the RSS Feed URL on the server row from your rsync.net account - the field is blank on edit by design, and leaving it blank keeps whatever is stored. Tools > Logs > Module records each attempt.

2. "This account was not found in the usage feed"

   • The UID on the service does not appear in that server's feed. Confirm the account still exists and that the service is attached to the right server.

3. Figures look stale

   • Feed reads are cached (5 hours by default). Wait for the cache to expire, or clear Blesta's cache.

Contact Us

If you encounter any issues or have suggestions for improving the module and plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Rsync Disk Manager Plugin by Blesta.Club - Product Overview

Welcome, and thank you for choosing the Rsync Disk Manager plugin! This guide provides an overview of how it bills rsync.net backup account usage automatically on every invoice Blesta creates.

Plugin Capabilities

The Rsync Disk Manager plugin is the billing half of a two-extension pair. Its companion, the Rsync Disk Information Module, stores each service's rsync.net account and shows clients their own usage; this plugin owns the pricing and rewrites each invoice line from that same usage, so what the client sees on their service page is exactly what they are billed. It provisions nothing itself: rsync.net accounts are created directly with rsync.net and simply attached to a Blesta service, then this plugin takes over the billing from there.

Key Features

• Usage-Based Invoicing, Applied Automatically: As each invoice is created, the amount on every Rsync Disk line is rewritten from that account's current rsync.net usage - no usage reports to read and no invoices to edit by hand.
• Pricing You Set in Plain Words: A price per unit of storage, a minimum charge, a round-down cutoff and a geo-redundancy surcharge, all set from one settings screen.
• The Working Shown on the Invoice: Every repriced line carries its own usage breakdown, so clients can see how the figure was reached without asking support.
• Billing Preview: See exactly what every active service would be invoiced under the current pricing, refreshed on demand so a slow rsync.net feed never holds the settings form open.
• Never Blocks Invoicing: If a usage feed is unreachable or an account is missing from it, that one line keeps the price it already had and the problem is logged - a price is never guessed.
• Built-In Demo Mode: Trial the settings screen and the billing preview against bundled sample data, with no rsync.net account and no feed URL.

Contact Us

If you encounter any issues or have suggestions for improving the module and plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Rsync Disk Manager - Installation Guide

Welcome, and thank you for choosing the Rsync Disk Manager plugin! We're delighted to have you as a customer and are committed to ensuring you have a seamless experience. This README aims to guide you through the installation of your new plugin. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

Before You Start

• The Rsync Disk module is required. This plugin is the billing half of a pair: the module stores each service's rsync.net account UID and shows its usage, and this plugin rewrites the invoice line from that usage. Install the same release of the Rsync Disk module (v3.0.0 alongside this plugin; never below v2.0.0, which is where the module started handling the account UID the way this plugin expects) before installing this plugin - the two halves are only tested and supported together as a matched pair.
• Version 3.0.0 and newer require Blesta 6.0 or newer; Blesta 5 installations should use v2.0.0 of both halves.
• Ensure you have the Blesta.club Subscription Manager installed if this item is leased. If you are using an owned source version, the Subscription Manager is not required.
• Your server needs PHP's SimpleXML extension, which the plugin uses to read the rsync.net usage feed. Installation stops with a clear error if it is missing.
• Your staff account needs the Install Plugin permission (under Settings > Plugins). Grant it on Settings > System > Staff Groups > Manage if your account does not already have full admin access.

Installation Guide

Follow these steps to install the Rsync Disk Manager plugin:

1. Download the Plugin Files:

   • Download the Rsync Disk Manager plugin files from the download section of the client area.

2. Upload the Plugin Files:

   • Upload the plugin files to a /plugins/rsync_disk_manager/ directory within your Blesta installation path. For example:

     /var/www/html/blesta/plugins/rsync_disk_manager/

3. Log in to Blesta Admin:

   • Log in to your admin Blesta account.

4. Navigate to Plugins:

   • Go to Settings > Company > Plugins.

5. Install the Plugin:

   • Find the Rsync Disk Manager plugin and click the "Install" button.

Installation seeds a default set of pricing settings for the current company, so nothing is billed differently until you review them. Proceed to the usage guide to set your prices.

Contact Us

If you encounter any issues or have suggestions for improving the plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Rsync Disk Manager - Update Guide

Keeping your Rsync Disk Manager plugin up-to-date ensures you have the latest features and security improvements. Follow these steps to update your plugin:

Update Steps

1. Backup Existing Plugin Files:

   • It's always a good practice to backup your existing plugin files before making any updates. Back up your database too: updating from a version below 1.1.0 runs a schema change on the plugin's settings table.

2. Update the Rsync Disk Module First:

   • This plugin and the Rsync Disk module ship as a matched pair. Update the module to the same release as this plugin (v3.0.0; never below v2.0.0) before updating this plugin, and keep both at the same release from then on.

3. Download the Latest Version:

   • Download the latest version of the Rsync Disk Manager plugin files from the client area.

4. Upload New Plugin Files:

   • Upload the new plugin files to your Blesta plugins directory, overwriting the existing files:

     /var/www/html/blesta/plugins/rsync_disk_manager/

5. Log in to Blesta Admin:

   • Log in to your Blesta admin account.

6. Navigate to Plugins:

   • Go to Settings > Company > Plugins.

7. Update the Plugin:

   • Find the Rsync Disk Manager plugin and click the "Update" button.

What Changes in This Release

• Blesta 6 is now required. Version 3.0.0 of both halves runs on Blesta 6.0 or newer only: the settings screen was rebuilt for the Blesta 6 admin interface, including its dark mode, and no longer renders correctly under Blesta 5. If you are still on Blesta 5, stay on v2.0.0 of both the module and the plugin until you upgrade Blesta itself.
• The pricing fields have clearer names. The "Charge ... for ..." pair is now Price per Unit and Unit Size, and each value's unit (GB, per GB used) is shown beside its field. Nothing about the stored values or the billing changes.

What Changed in 2.0.0

• Invoice lines now carry a usage breakdown. A repriced line's description gains a short explanation of the usage it was billed for ("1,499 GB used, billed as 1,500 GB @ 12.50 per 500 GB"). This text appears on invoices your clients receive, so review the wording against your own invoice template before updating a live install.
• The settings screen gained a Billing Preview. It lists every active Rsync Disk service and the amount its next invoice line would be rewritten to. Opening the page reads only usage that has already been fetched; the new Refresh Preview button is what performs a live read of your rsync.net feeds. That is an outbound request to rsync.net made only when you press it.
• Review your pricing settings after updating. No values are changed by the update, but the preview makes it easy to confirm they still produce the amounts you expect before the next invoice run.

Keep your Rsync Disk Manager plugin up-to-date to ensure you have the latest features and improvements.

Contact Us

If you encounter any issues or have suggestions for improving the plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Rsync Disk Manager - Usage Guide

Once your Rsync Disk Manager plugin is installed, you'll want to configure it to suit your needs. Follow the steps below for a comprehensive setup.

Setting Up the Plugin

1. Install the Plugin:

   • Follow the installation guide to install the Rsync Disk Manager plugin, and make sure the Rsync Disk module is installed and has at least one server row with your rsync.net usage feed URL.

2. Open the Settings Screen:

   • Log in to your Blesta admin account.
   • Navigate to Settings > Company > Plugins.
   • Find the Rsync Disk Manager plugin in the list of installed plugins and click on the "Manage" button.

3. Set Your Pricing:

   • Price per Unit and Unit Size: the amount charged for each block of storage, and how large that block is in GB (for example 12.50 per 500 GB).
   • Minimum Price: the floor for a repriced line. It floors the money only; it never changes the number of blocks shown on the invoice.
   • Round Down Cutoff: how many GB into a partial block a client has to be before that block is charged. Below the cutoff the partial block is free.
   • Geo Redundancy Price: the per-GB surcharge for accounts rsync.net reports as geo-redundant.
   • Apply Geo Redundancy To: whether the surcharge is charged on the rounded GB actually billed, or on the exact GB used.

4. Check the Billing Preview:

   • The Billing Preview panel below the form lists every active Rsync Disk service and the amount its next invoice line would be rewritten to under the pricing above.
   • Opening the page shows only usage that has already been read. Press Refresh Preview to read the rsync.net feeds again. This is deliberate: reading the feeds is a live request, and the settings form must stay usable even when rsync.net is slow or unreachable.
   • A service whose server row has Mock API Mode enabled previews against the bundled demo feed, so you can see the whole screen working before pointing it at a real account.

How Billing Works

Whenever Blesta creates an invoice, every line belonging to an Rsync Disk service is repriced from that account's current rsync.net usage. Lines for any other product are untouched, and the client sees a short usage breakdown appended to the line so the amount is explained on the invoice itself.

If the usage cannot be read - no pricing settings, an unreachable feed, or an account UID the feed does not list - the line is left exactly as the package priced it and the reason is written to the system log. Invoicing is never blocked and a price is never guessed.

Contact Us

If you encounter any issues or have suggestions for improving the plugin, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.