OwnCloud WHMCS Module

From WHMCS Global Services Module Documentation
Jump to: navigation, search

ownCloud WHMCS Module

Provisioning Module

This module offers automatic provision of ownCloud accounts from WHMCS with specified details. It also facilitates

To suspend account when a service become overdue on payment or can also be done by WHMCS admin user manually

To activate suspended accounts

To terminate ownCloud accounts and all their related data from storage. This process will not be undone.

Client Area of Provisioning Module

User's ownCloud account details are available on client area. It also has "Single Click Login" feature, User can login to created ownCloud account by clicking on "Owncloud Login" button. If user has forgotten password, can reset it from here and can change owncloud email address.

Email Template

Email Template is automatically created when you configured provisioning module. Admin user can edit its contents accordingly.

Addon Module

This module provides you the admin control of ownCloud admin user. To view created users you don't have any need to login your ownCloud installation. You can view ownCloud users list from your WHMCS admin area and edit them. You also can add new ownCloud Group and User.

Getting started with ownCloud

Installation

To install owncloud desktop client on your server follow the link https://owncloud.com/download

Here you will get installation procedure of owncloud on Windows, Mac OS X and Linux After successful installation, Install "whmcs_integration" App to ownCloud:

Step 1: Upload "whmcs_integration" app to ownCloud apps directory.

Wiapp.png

Step 2: Get log in to ownCloud as an admin user.

Step 3: On home page, Click on Apps link in top left corner to open ownCloud app management interface.

Step 4: Locate "whmcs_integration" third party app, enable it from here.

OwnCloudAppStep1.jpg

Step 5: Click on "WHMCS" link and you will open to a view, where you can manage account limit

OwnCloudAppStep2.jpg

Step 6: Click on top right corner dropdown, and select "Admin" option.

Step 7: Under WHMCS Integration App", Admin can update message to show for suspended users.

Updatemsg.png

WHMCS Provisioning Module for ownCloud

Configure Provisioning Module in WHMCS

Upload provisioning module "owncloud" directory in www.example.com/whmcs/modules/servers

Step 1: Setup server for "owncloud" module. Setup -> Products/Services -> Servers

Server.png

Step 2: Create Product for "owncloud" and Proceed to configure "owncloud" provisioning Module.

Step 3: Click on Tab Module Settings, select "owncloud".

OwncloudProvisioning.png

Step 4: Module Configuration

  • License Key will be validating from Admin Area Module automatically
  • Enter "whmcs_integration" in APP ID field
  • Enter "/ocs/v1.php/cloud/" in API URL
  • Enter "groups" in Group API field
  • Fill Server Name field with server name which you have made for "owncloud" module in setup->product/services->servers
  • Fill owncloud login button name as you wish to show in client area.
  • Select corresponding username, password, groups and quota fields from list, which are automatically created when you are configuring module.
  • Under "Cloud Module Settings", Your edit product page will show you an option "Character Encoding". You do not need to know what the encoding of your string is, It can be Latin1 (iso 8859-1), Windows-1252 or UTF8, or the string can have a mix of them. You will have to check this option to encode your characters.


You can configure module in two modes

Owncloud Quota

a. Choose Quota by Client during order

By default this option is enabled. When this option is enabled ("Manage Quota" check box is unchecked). A configurable option is there to select quota by client during order process. You can edit quota configurable option as per requirement.

b. Set Quota by Admin

You will see an option "Manage Quota" while configuring module from WHMCS admin area. When you enable this option, You will see an text box to enter quota value. You can select quota units from "Quota Units" under Cloud Module Settings section.

Create ownCloud Reseller

If you want create the reseller product than follow the below instruction to create the ownCloud Reseller Product in WHMCS.

f. Reseller Module Settings Use as a reseller : If this option checked that means you are creating the reseller product once you enabled this option you should get the " Default Account Limit " filed enabled.

Default Account Limit : Here you can set how many user your reseller can create under their reseller account.

Auto Generate User : If this option is enabled than during checkout your customer don't need to enter their owncloud username / password. Our module will pick the default WHMCS username & password automatically.


thumb

Email Template

After configuring module for user provisioning, You will see a template named "Owncloud Account Welcome Email" Go to setup-> Email Templates, Locate "Owncloud Account Welcome Email" You can change contents as you wish.

In Module configuration, Make sure that you have filled "Email Template Name" field. Default value is "Owncloud Account Welcome Email". If you have changed name of template then must update this field.


Step 5: Now move to Custom Fields Tab, You will see three custom fields:

  • Owncloud Username(textbox)
  • Owncloud Password(password)
  • Owncloud Group(dropdown)
Customfields.png

Step 6: A configurable option of quantity type is also automatically created.

  • Quantity Type
You can change its range and price as you required.

You can also change its type to any other available type. For e.g. Dropdown

  • Dropdown
Quantity.png


Make sure that quota field forwarding a numeric value only.

If you are using a drop down and you want to show users custom options then use following format to

add options for configurable options.

Numeric value | Value for user

For Example: 1 | 1 GB Space

framed

Client Area View

thumb
thumb

With active service in WHMCS with owncloud module, Customer can change Owncloud Email Address. Owncloud Auto Login button will login to your owncloud account with a single click.

Client Area: If module is not configured properly, then you will appear with error message on client area.

thumb

WHMCS Admin Area Module for ownCloud

Installation

  • Upload owncloud directory of admin area addon
     www.example.com/whmcs/modules/addons
  • Activate it
     Setup > Addon Modules

After activating, Click on configure. All fields are required here. Do not try to change default values.

  1. License Key: Enter your valid license key.
  2. License Status: Do not try to change License Status, It will work according to your license validation. If you changed its value, then you are not able to configure provisioning module.
  3. Owncloud APP ID: Fill "whmcs_integration" omitting quotes
  4. Owncloud API URL: Fill "/ocs/v1.php/cloud/" omitting quotes
Whmcsadminareaaddonconfig.png
  • Locate Owncloud module
     Addons > owncloud

This will list all ownCloud users. You can change user's Display Name, Password, Groups, Group Admins and Quota. You can also Delete User from here.

You can see a dropdown in the right menu bar, This will show you the list servers that you have configured for owncloud. If you have more than one owncloud installations then you can add servers from setup -> products/services -> servers. Servers which are connected with owncloud provisioning module will automatically show in the select box. You can easily switch your servers to manage owncloud from WHMCS as an admin.

WHMCSAdminAddon5.jpg

To manage Owncloud Groups, Click on Manage Groups link. Admin user can set limit for groups except main admin group. By clicking on view link, can see users in a group and Admin users of the group.

Owncloudgroups.jpg

To add new ownCloud user, click on Add User link. You also can add order for client for owncloud product that you have configured already. If you want to create user only at only owncloud not to create order then don't select any client and product.

WHMCSAdminAddon3.jpg

Important When Upgrade to Latest Version

 Do not forget to remove 'owncloudGroups.php' file from includes/hooks folder

How to change the language

Add the below variable in your whmcsdir/lang/english.php file and you can change the value as per your convenient.

$_LANG['OwncloudSettings'] = "Owncloud Settings";
$_LANG['EmailAddress'] = "Email Address";
$_LANG['ChangeOwncloudEmailAddress'] = "Change Owncloud Email Address";
$_LANG['OwncloudEmailAddress'] = "Owncloud Email Address";