We will be walking you through setting up the Stratumsphere plugin on Clientexec. This will let Clientexec handle the provisioning of rentals through the Stratumsphere API.

This guide will not be going through items like Payment Processors, Email Automation, Invoice Automation, etc. Please refer to the Official Clientexec Documentation for information on those generic topics.

Requirements
Clientexec Version 5.8.0 or newer fully installed and ready for use
Administrative or Owner access to the Stratumsphere account you wish to provision the rentals on
Deployed HASH Scheduler of any Algorithm and Type/Method
Laptop or Desktop, this setup cannot be done on a mobile device
At least 1 hour if you are a novice to eCommerce platforms, 30 minutes or less if you are somewhat familiar with Clientexec or other eCommerce systems.

Please remember that if you purchased Clientexec hosting from Stratumsphere through the Extras page, we will help you configure the plugins. This guide is intended for those that are self-hosting Clientexec.

Login to Clientexec

Head to https://YourClientexecURL.com/admin and login with your admin account.

The page on login should look similar to this:
Clientexec Login

Add Custom Fields

Clientexec was originally intended for websites, web hosting, virtual machines, etc. As such there is no mining pool type entries, so we need to go ahead and add them.

Required Custom Fields
Primary Pool Hostname
Primary Pool Username
Primary Pool Password
Secondary Pool Hostname
Secondary Pool Username
Secondary Pool Password

Go to Settings -> Products -> Custom Fields

The Custom Fields section is more than likely empty unless you use your Clientexec install for other items. The page should look something like this if empty:
Product Custom Fields - Empty

Click Add Custom Field

Add "Primary Pool Hostname" to the text dialog that appears and click OK.

Should look as such:
Primary Pool Hostname

Configure Primary Pool Hostname Field

Ensure that the following items are enabled:
Is Required:
Is Changeeable:
Include in Signup:
All Product Groups:

Field Information should look like this:
Field Information

Just something to note, you can disable "Is Required" if desired on these fields. This may be useful if you want your customers to be able to just checkout without inputting anything, but it's typically not a great idea. You can also update the Field Description in the future at anytime.

Click Save

We still need to add the rest of the required custom fields, but you probably get the gist of what you need to do. The rest of the custom fields in this guide will simply be steps and screenshots.

Click Add Custom Field Again

Configure Primary Pool Username

Primary Pool Username

Click Save

Click Add Custom Field

Configure Primary Pool Password

Primary Pool Password

Click Save

Click Add Custom Field

Configure Secondary Pool Hostname

Secondary Pool Hostname

Click Save

Click Add Custom Field

Configure Secondary Pool Username

Secondary Pool Username

Click Save

Click Add Custom Field

Configure Secondary Pool Password

Secondary Pool Password

You should now be done adding custom fields.

Configure Stratumsphere Server

Now we will be setting up the Stratumsphere Server, aka API that Clientexec will use to provision rentals.

Go to Settings -> Products -> Servers

The page should look like such:
Servers Page

Click Add Server

You should be presented with a page that lists things such as Server Name, Hostname, etc.

Fill out the following Information:
Server Name = Stratumsphere1
Hostname = api.stratumsphere.io
Plugin = Choose Stratumsphere (Threshold) or Stratumsphere (Miner-To-Miner) depending on the type of Schedulers you want to use. Remember you can add more than 1 server if you want to support different scheduler types.
API Key = Input your Stratumsphere API Key, if you don't know how to retrieve it then checkout this article.
Primary Pool Hostname Custom Field = Primary Pool Hostname
Primary Pool Username Custom Field = Primary Pool Username
Primary Pool Password Custom Field = Primary Pool Password
Secondary Pool Hostname Custom Field = Secondary Pool Hostname
Secondary Pool Username Custom Field = Secondary Pool Username
Secondary Pool Password Custom Field = Secondary Pool Password

The Add Server page should now look like such:
Add Server Page

Click Save Changes
Click on the new server in the table
Click "Test Connection"
You should see a success message:
Test Connection

You have successfully connected Clientexec to Stratumsphere. Now let's configure your products.

Configure Products

Products are required if you want to sell something through Clientexec. It will also tell Stratumsphere how many miners/hashrate and which scheduler to use for that specific rental.

Go to Settings -> Products -> Products

If this is a fresh install of Clientexec, you should see some default product groups:
Default Product Groups

Delete Existing Product Groups

You will want to delete the existing Product Groups. If this is a preexisting install of Clientexec with other products on it, you would want to skip this step.

Delete Product Groups

Repeat the same delete product group steps for the two remaining default product groups. The Products page should be empty.

Add Mining Product Group

Under the Products page, you will want to Click "Add Product Group" like such:
Add Product Group

You should be presented with a page called "Product Group Window" that lists things such as Group Name, Type, Description, etc.

Set the following information:
Group Name = Something you want your customer's to see, for this guide we'll use "Ethash Cloud Mining"
Type = Hosting, This MUST be selected or the Stratumsphere plugins will not function properly on this group.
Description = Write something descriptive and fun for your customers!
Group Order = 1, you can change this later.
Include in Signup = Yes
Product List Style = Pick whatever you desire. Default lists products in this group in collapsible tables on top of each other, while Compare puts them side-by-side.
Custom FIelds = Leave blank
Custom Fields for All Product Groups = You should see the ones we added earlier, if not you messed something up and you should read through this guide again.

The Product Group Window should look like such:
Product Group Window

Click Submit

After clicking submit, you should see your new Product Group populate in the table in the Products page:


Add Product

Now we will be adding the actual product, aka mining rental that you will be selling to your customers.

Click the red "No products available - Click to add..."

You should be presented with a page that says "Product for <Your Product Group Name>", like such:
Add Product Page

Set the following information:
Product Name = Whatever you desire to name the product, in this example we'll use "Small" to signify a small package.
Signup Order = 1, can be changed later.
Welcome Email = None for now, you can set this yourself later.
Description = Describe what you are selling! If you chose the compare option, you'll have to list things in a separate box.
Allow direct link = Check the box if you want to be able to link this directly from another website (like your frontpage, a slider, etc.)
Show in signup form? = Yes
Send welcome email? = No, but you can change it later when you write a welcome email.
Automatically Activate Package? = Yes, but it won't actually activate until you setup your payment processor in the future (out of the scope of this guide).
Open Ticket? = No
Domain Products? = No
SSL Certificate Products? = No
Subdomains = Leave blank
Hide hosting custom fields = Check the box, Yes
Enable stock control options? = Entirely up to you as a business.

Your current add Product General tab should look like this:
Add Product, General

Note: That is the Compare list product group, if you did not select compare then the Asset List won't appear.

Click Save Changes
Click on the Pricing Tab
Pricing Tab

Set the Pricing you want and if you want to allow it in Signup, you will need to allow at least one option otherwise the product won't appear in the sign-up page.

We won't be providing any examples for the Pricing Tab, this is a business decision that you need to make. Fairly straight forward.

Click Save Changes on the Pricing Tab

We will be skipping the Addons section, you can configure that yourself in the future if you want to add any freebies to your mining packages at some point.

Click on the Advanced & Plugin Settings

When you click on the "Associated Servers" bar, you should see options populate for the Stratumsphere Server(s) we added earlier in the guide. Select the one you want to use, whether that is M2M or Threshold.

Associated Servers

Depending on the type of Stratumsphere Server you selected, you will be presented with several options. However, both require a Scheduler ID so we will be going into how to get that first.

Scheduler ID

Login to your Stratumsphere Account
Go to Schedulers -> Scheduler you want the rentals to populate on
It's important to understand that the Server type and Scheduler Type need to match, you can't create M2M rentals on a Threshold Scheduler or vice-versa.

You will find your Scheduler ID in the Stratumsphere URL in your browser. It will be a 3 or 4 digit number.

https://app.stratumsphere.io/scheduler/overview/1234

Here is a real example from Chrome Browser:
Scheduler ID

Copy and paste your Scheduler ID into the Advanced & Plugin Settings tab:


M2M Plugin Settings

For the M2M Plugin, you would just set the Number of Workers you want to associate with that package. If you want to sell 1 Antminer S9 as an example, then you would set the Number of Workers to 1. If you want to sell 2, then set the Number of Workers to 2, so on and so forth. Keep in mind that your customers cannot select a quantity on checkout, unless you use the direct link to an off-site slider. There is plenty of tricks for that in the future and we won't go over that in this guide.

Append Worker Names, select this option if you want to show your customer the actual worker names. This may not be the best option if the customer is a novice, in a majority of cases it is better to hide the worker names.

Here is what the M2M Plugin Settings should look like once filled out:
M2M Plugin Settings

Threshold Plugin Settings

For the Threshold Plugin, you would select the amount of hashrate you want to sell and the unit of value. IE 1 GH/s would be 1 in the Threshold box and then you'd select GH/s under the Hash Rate drop down. Tolerance is also set to your liking, whatever you want to guarantee that customer.

Append Worker Names, select this option if you want to show your customer the actual worker names. This may not be the best option if the customer is a novice, in a majority of cases it is better to hide the worker names. This is an ill-advised option especially for Threshold, since workers jump frequently in this methodology.

Here is what the Threshold Plugin Settings should look like once filled out:
Threshold Plugin Settings

Click Save Changes
Click the ↑ Product list link above the General tab

Your Products section of Clientexec should look something like this now:
Products with Package

Feel free now to add any more Product Groups/Packages that you desire.

Checkout Test

Now that we've setup the Stratumsphere Plugins and some products, we need to test it.

Add Test Customer

Go to Accounts -> All Customers
Click Add User

Go ahead and add a fake customer like such:
Add Test Customer

Click Submit

The customer should now populate the All Customers table.

Click on Fake Customer's Name
View as Fake Customer

In the top-right corner, you should see the fake customer's name populate with several buttons. Go ahead and click on the Eyeball icon underneath the customer's name. Example here:
Eyeball Icon

Client Portal Page

You should now see a page that says "Client portal" on the top and some info about packages, invoices, etc. Example:
Client portal

Click Packages Drop-down
Click Order new services
Order new services

You should see a page that looks like this, keep in mind that depending on the list type you chose for your product group this may look different. Example:
Order Page

Click Order Now
Select a package that you know is actually configured properly, otherwise this test won't work.

You should see a page that looks like this, go ahead and fill-out your pool information as desired (address blurred for privacy):

Configure Package

Click Continue

You should now be presented with a checkout/cart page. If you had a payment processor (which we did not setup in this example) then you'd be directed to pay after clicking "Place Order".

Checkout Page

Click Place Order

Clientexec by default will not auto complete orders on systems that do not have a payment processor in-place. This is designed to prevent outside abuse during testing/setup.

Activate in Admin panel

We need to manually activate the package to finally test, as stated above it won't do it if the payment processor is not in-place (which we are not going over in this guide).

Click "Return to Admin View"

Return to Admin View

Go to "Dashboard" -> Click "Pending Orders"

You should see the package under the example customer that you ordered. Go ahead and checkmark the package.

Click "Activate Packages(s)"

Activate Package

You will be prompted with a dialog asking if you are sure, make sure to select "Use their respective plugins?" in order to utilize the Stratumsphere you setup earlier plugin to provision this rental product.

Package Activation Prompt

Click Yes

The package should be now be provisioned for the example customer and on Stratumsphere. Let's verify the creation of the rental on your scheduler.

Back to Stratumsphere
Go to your Scheduler

Make sure it's the scheduler we setup earlier for the product.

Click "Rentals"

On your scheduler, you see the rental provisioned with the ID and product name from Clientexec.

Provisioned Rental

Make sure to crosscheck the product name and ID with the information on Clientexec to make sure everything is ok.

Completion

If you login as your example customer again and go to Packages -> Package List you will see that the package is present with options to edit the pool, pool password, billing, etc.

That's it, the Stratumsphere plugin has been setup. Make sure to follow the same procedure for other products, schedulers etc. Clientexec is very agile and you should be able to really customize the products and settings as needed. Want to force a certain set of pools? Make a dropdown as an example under custom fields rather then a text input. There is a plethora of things you can do and we highly suggest that you do some experimentation before going live with the system.

Some Notes

Remember, Clientexec will not do an automated task unless you tell it to. Things like batch credit card processing, renewal invoices, suspensions, etc. need to be enabled. Go to Settings -> Plugins -> Automation Services to enable all of this.

Do not forget to checkout the official Clientexec Documentation for more help and information setting up your eCommerce platform.
Was this article helpful?
Thank you!