Nextcloud Module by Blesta.Club - Product Overview

Welcome, and thank you for choosing the Nextcloud Module! Selling Nextcloud storage or groupware access usually means creating and managing user accounts by hand on your instance every time someone orders, upgrades, or cancels. This module removes that work: Blesta creates, sizes, groups, suspends, and removes the Nextcloud account automatically as the service moves through its lifecycle, so a paid order becomes a working Nextcloud login with no manual step in between.

Key Features

• Automatic Provisioning: A paid order creates the client's Nextcloud user right away, with a unique username and a strong generated password, and pushes suspension, reactivation, and cancellation to the instance without staff touching anything.
• Per-Package Storage Quotas: Give every package its own storage allowance in GB, including fractional values like 0.5 GB, applied at order time and re-applied automatically on an upgrade or downgrade.
• Nextcloud Group Assignment: List the Nextcloud groups a package's users belong to and the module assigns and reconciles them automatically, with group membership also overridable through a configurable option.
• Multi-Instance Capacity Control: Run as many Nextcloud instances as you like, each with its own storage capacity, and orders that would over-allocate a full instance are refused instead of silently failing.
• Automatic Server Selection: Group your instances together and let Blesta place each new account on the least-full server or spread accounts evenly across the group.
• Staff and Client Self-Service: Staff get an Actions tab to enable, disable, reset the password of, or re-sync the quota of an account; clients get their own Actions tab to change their password and jump straight into Nextcloud.
• Usage Statistics: A staff Statistics tab shows the account's storage quota usage, and the client's own Statistics tab adds their display name and a usage bar, both scaled automatically to the right unit.
• Login Details at a Glance: The service view shows the account's username and password, with click-to-copy buttons on the client side, so clients can sign in immediately and staff can help without digging.
• Built-In Demo Mode: A Mock API mode lets you trial every screen and action using built-in sample data, with no Nextcloud instance or API key required.

Things to Note

1. Capacity Management: Set a storage capacity limit per server to prevent exceeding available space; leave it at 0 for no limit.
2. Configurable Options: Clients can be offered a choice of storage quota or Nextcloud groups at checkout using configurable options named to match.

Contact Us

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

Nextcloud Module by Blesta.Club - Installation Guide

This guide provides step-by-step instructions for installing the Nextcloud Module, allowing your clients to be provisioned with Nextcloud accounts through Blesta.

Prerequisites

1. Nextcloud API Credentials: You will need an app username and password generated from your Nextcloud instance (see "Quick Support" in the Usage Guide for how to generate one), unless you plan to try the module first in Mock API mode (see below).
2. Blesta Installation: Ensure Blesta 6.0 or newer is installed and functional. Version 3.x of this module targets the Blesta 6 admin theme; it is not supported on Blesta 5.
3. Blesta Club License Manager: Ensure this is installed and functional if you are using a leased license.

Installation Steps

1. Download and Upload the Module

1. Download the Nextcloud Module from your account.
2. Upload the module to your Blesta directory:

   /var/www/html/blesta/components/modules/nextcloud/

2. Install the Module

1. Log in to your Blesta admin area with a staff account that has the Modules permission (specifically Install Module and Manage Module) under the Settings group in Manage Staff Groups.
2. Navigate to Settings > Company > Modules.
3. Find Nextcloud under the Available tab and click Install.

3. Add a Server

1. Navigate to Settings > Company > Modules > Installed and click Manage on the Nextcloud module.
2. Click Add Server in the top right corner.
3. Fill out the server details:
   • Label: A name for the server, shown to staff in the admin panel.
   • Hostname: The full URL of your Nextcloud instance, including http(s)://, e.g. https://cloud.mycompany.com.
   • API Username / API Password: The app credentials from your Nextcloud instance.
   • Capacity (GB): The maximum storage this server may provision in total. Set to 0 for no limit.
   • Enable Mock API: (Optional) Tick this to run the server entirely on built-in sample data instead of a live Nextcloud instance, so you can test the whole order, suspend, and cancel flow before you have real credentials.
4. Click Add Server to save.

Optional - multiple instances: if you run more than one Nextcloud instance, add each as its own server, then create a Server Group containing them and choose whether new accounts go to the least-full server or are spread evenly across the group.

4. Configure a Package

1. Create or edit a package and select Nextcloud as its module, then choose the Server (or Server Group) this package provisions on.
2. On the package's module fields, set:
   • Storage (GB): The storage quota provisioned for services on this package.
   • Nextcloud Groups: A comma-separated list of Nextcloud groups new accounts on this package should belong to (leave blank if you don't use groups).

The Nextcloud Module is now installed and ready for use.

Contact Us

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

Nextcloud Module by Blesta.Club - Update Guide

To ensure you're always using the latest version of the Nextcloud Module, follow these steps to update the module in your Blesta installation.

Steps for Updating the Module

1. Download the Latest Version

• Visit the download section of your account to obtain the latest version of the Nextcloud Module.

2. Upload the Updated Module

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

   /var/www/html/blesta/components/modules/nextcloud/

3. Update the Module in Blesta

• Log in to your Blesta admin account.
• Navigate to Settings > Company > Modules > Installed.
• Locate Nextcloud in the list and click Upgrade if it's shown.

4. Check Configuration

• After the update, review your server(s) under Settings > Company > Modules > Installed > Nextcloud > Manage to confirm the API credentials are still correct.

Upgrading to 3.0.0

Version 3.0.0 requires Blesta 6.0 or newer. Upgrade Blesta first, then upload the module files and click Upgrade as described above. No settings change: your servers, packages and services carry over as they are. All staff-facing screens now use the Blesta 6 admin theme and follow its light or dark mode.

Upgrading to 2.0.0

If you're upgrading from an earlier version, note the following:

• The API Password field on a server's Edit page no longer shows the stored password on screen. Leave it blank when saving to keep the existing password; it is not being cleared.
• If you want new accounts placed in specific Nextcloud groups, add a Nextcloud Groups value to the relevant package(s) - existing packages are unaffected until you set one.
• A new Mock API option is available on each server if you want to test the module without contacting your live Nextcloud instance; existing servers are unaffected unless you enable it yourself.

Otherwise, this update is a drop-in replacement with no other configuration changes required.

Troubleshooting Update Issues

1. Missing or Incorrect Files:

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

2. API Key Issues:

   • If provisioning actions are failing, check that the correct API credentials are configured in the module settings.

3. Compatibility Issues:

   • Confirm that the updated version of the module is compatible with your current Blesta version. 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, please reach out to us. We are dedicated to providing robust updates and value customer feedback.

Nextcloud Module by Blesta.Club - Usage Guide

Welcome, and thank you for purchasing the Nextcloud Module! This guide will walk you through how to use the module to provision Nextcloud accounts through Blesta. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

Configurable Options

If you want clients to choose their own storage amount or Nextcloud groups at checkout, add a configurable option whose Name matches the package field it should override:

1. Create a Configurable Option in Blesta named storage_quota to let clients choose their storage size (values in GB), or named groups to let clients choose which Nextcloud group(s) they belong to.
2. Define the option's values as you would any other configurable option.

Note: Be mindful of using a storage_quota option alongside the module's server capacity limit, so client choices can't exceed the space you have available.

Staff: Managing an Account

A client's Nextcloud service shows a summary of its Username and Password on the client's Services list (expand the service to see it), and two tabs:

• Actions: buttons for Open Nextcloud, Enable Account, Disable Account, Reset Password, and Re-sync Quota. Enable and Disable are both always shown regardless of the account's current state, so use whichever matches what you want to do. Disabling the account and resetting its password both ask for confirmation before they take effect, since they immediately change what the client can access. Re-sync Quota pushes the current package's Storage (GB) value back to the Nextcloud account, useful after changing a package's quota.
• Statistics: a single Storage Quota reading, shown as used / quota (or "/ Unlimited" for an unlimited package), in whichever unit (MB, GB, or TB) fits best.

Attaching an Existing Nextcloud Account

Adding or editing a service also shows Username and Password fields for the account. Leaving Blesta to generate an order normally is the default, but if you untick Use Module and type in the username and password of an account that already exists on your Nextcloud instance, Blesta attaches to it instead of creating a new one.

Client: Self-Service

From their side, clients see the same Username/Password summary (with click-to-copy buttons), and two tabs on their service:

• Actions: a Change Password form to set a new Nextcloud password at any time, and an Open Nextcloud button that links straight to the instance.
• Statistics: their account's display name, and a storage usage bar showing how much of their quota is used (with a percentage, or "/ Unlimited" for an unlimited package).

Quick Support

Where Are My API Username and Password?

1. Log In to Nextcloud:

   • Access your Nextcloud panel with an admin account.

2. Generate API Credentials:

   • Go to /settings/user/security.
   • Under "Devices & sessions", create a new app password.
   • The displayed Username and Password are your API credentials for the module. Save them, as they will not be displayed again after you close the window.

Email Tags

• module: label, host, capacity
• package: storage_quota
• service: username, password

Contact Us

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