# Dashboard

Dashboard helps quickly navigate to user's Products. It includes the following tabs:

# Products

Click Dashboard. You will be redirected to the Products page.

On the Products page you can see all your products.

The following actions are available:

• Create activation key/Activation Key. Activation Key is a string of numbers and letters used to activate a product. If an activation key is not created yet, you can do it by clicking Create activation key. A new key will be created and displayed. To copy an activation key to clipboard, just click on it.
• Add Licenses — shortcut to Product Purchase page.
• Manage Product — shortcut to Product Activation Keys page.
• Read more — click to get more information about the product.

# Trial Activation

On the Product tab a user can activate a trial license if trial product hasn't been activated yet.

Just click Free Trial and proceed with trial activation instructions.

Also, a user is able to activate trial license from the Purchase page.

# CloudLinux OS Activation Keys

Click CloudLinux OS at the top menu to go to CloudLinux OS Activation Keys page. Here you can see server licenses used/limits.

The following actions are available:

• Copy a Default Activation Key to a clipboard. To do so, click Copy below the default key.
• Generate a new Activation Key. To do so, click Generate new activation key. Specify the number of servers and some notes if any and click Save Changes to confirm the action or Cancel to close the popup.
• Manage servers.
• Add server licenses or buy, if only trial product is activated.
• Remove unused server licenses. Click Remove unused server licenses to delete all server licenses that are not used to activate a server. Do it to reduce your monthly bill as a customer pays per each server license and NOT per an activated server. Confirm the action in the opened popup by clicking Remove or click Cancel to close the popup.
• Go to Activation Key Details page. To do so, click a specific activation key in the table.

The table with a list of all CloudLinux OS Activation Keys has the following columns:

• Activation key — activation key string. Click activation key to go to Activation Key Details page. *IP range — a range of IP addresses for a particular activation key;
• Note — any information you've added to a particular activation key;
• Servers (used/limits) — shows how many servers have already been activated with this key (used) and a total number of servers that can be activated with this key (limits).

The following actions are available:

• filter keys by server limits — click Server Limits and choose a desired number or unlimited
• search for an activation key — type a search query and the table will filter a list of keys
• delete one or several activation keys — tick one or several activation keys or the checkbox in the table header (to select all) and click Bin icon. In the popup, click Remove to confirm the action or Cancel to close popup.

# CloudLinux Activation Key Details Page

On the CloudLinux OS Activation Keys page click an activation key string in the table to go to CloudLinux Activation Key Details page.

This page contains the following information:

• activation key itself is displayed on the blue background; to copy it to clipboard just click it
• servers (used/limits) — number of servers that have already been activated with this key (used) and a total number of servers that can be registered with this particular key (limits)
• note — any information you’ve added to this activation key.

The following actions are available:

• Edit key. Click Edit Key button. In the opened popup you can change a number of servers that can be activated with this key and enter some notes for your own needs so that you can easily find an activation key when there are a lot of different keys. To apply changes click Save Changes or Cancel to close the popup.

  

• Remove key. Click Remove Activation Key button. In the opened popup click Remove to apply changes or Cancel to close the popup.

  Note

  You cannot delete a default activation key.

  

Below, there is a table with all servers activated with this activation key.

The table contains the following columns:

• Server name — a host name of the server.
• IP — an IP address of the activated server.
• Registered — a date when a server was activated. A server sends this information to CLN.
• Last check-in — a date of last successful server check-in .

The following actions are available:

• Filter servers list by date of registration. Click Registered Date and select a date or a period to show servers registered within selected period or date.
• Search in the list by a specific text. Type a search query in the search field to show specific servers.
• Remove a server from this activation key. In this case, a server will not be able to use CloudLinux OS anymore. To do that, tick server(s) and click Bin icon above the table.

# KernelCare Activation Keys

Click KernelCare at the top menu to go to KernelCare Activation Keys page. Here you can see server licenses (used/limits).

There are two types of KernelCare licenses available: IP-based and key-based. IP-based license can only be used by IP address it is issued to, while key-based licenses can be migrated to another server within the IP range defined for the key.

# Key-based licenses

Every KernelCare customer gets a default activation key upon license purchase. You can have multiple activation key in your account, however the overall number of licensed servers cannot exceed the number of purchased licenses.

The following actions are available:

• Copy a Default Activation Key. Click a key to copy it to a clipboard.
• Generate a new Activation Key. Click Generate new activation key. In an opened popup specify Server quantity limit, IP range limit, Sticky tag, and add some Notes, if any, and click Save Changes to confirm the action or Cancel to close the popup.
• Manage servers.
• Add server licenses.
• Remove unused server licenses . Click Remove unused server licenses to delete all server licenses that are not used to activate a server. Do it to reduce your monthly bill as a customer pays per each server license and NOT per an activated server. Confirm your action in the opened popup by clicking Remove or click Cancel to close the popup.
• Go to Activation Key Details page. To do so, click a specific activation key in the table.

The table with a list of of all KernelCare Activation Keys contains the following columns:

• Activation key — an activation key string. Click an activation key to go to Activation Key Details page.
• IP range — a range of IP addresses for a particular activation key;
• Note — any information you've added to a particular activation key;
• Servers (used/limits) — shows how many servers have already been activated with this key (used) and a total number of servers that can be activated with this key (limits).

The following actions are available:

• filter keys by server limits — click Server Limits and choose a desired number or unlimited;
• search for an activation key — type a search query and the table will filter a list of keys;
• delete one or several activation keys — tick one or several activation keys or the checkbox in the table header (to select all) and click Bin icon. In the popup, click Remove to confirm the action or Cancel to close popup.

# KernelCare Activation Key Details Page

On the KernelCare Activation Keys page click an activation key in the table to go to KernelCare Activation Key Details page.

This page contains the following information:

• An activation key itself is displayed on the blue background; to copy it to a clipboard just click it;
• Servers (used/limits ) — number of servers that have already been activated with this key (used) and a total number of servers that can be registered with this particular key (limits);
• Note — any information you’ve added to this activation key.
• Sticky tag — when the Sticky Tag feature is enabled for particular servers, all such servers will get patches only released before the date specified in the Sticky tag field.

The following actions are available:

• Edit key. Click Edit Key button. In the opened popup you can change a number of servers that can be activated with this key, change IP range limit, manage sticky tags (see Patch management with CLN portal (Sticky Tag)), and enter some notes. To apply changes click Save Changes or Cancel to close the popup.
• Remove key. Click Remove Activation Key button to  remove an activation key with all the associated servers. In the opened popup click Remove to apply changes or Cancel to close the popup.

Below, there is a table with all servers activated with this activation key.

The table contains the following columns:

• Server name — a hostname of the server.
• IP — an IP address of the activated server.
• Registered — a date when a server was activated. A server sends this information to CLN.
• Effective Kernel —  a version of kernel used.
• Last check-in — the date of last successful server check-in.

The following actions are available:

• Filter servers list by date of registration. Click Registered Date and select a date or a period to show servers registered within selected period or date.
• Search in the list by a specific query. Type a search query in the search field to show specific servers.
• Remove a server from this activation key. In this case, a server will not be able to use KernelCare anymore. To do so, tick server(s) and click Bin icon above the table.

# Patch management with CLN portal (Sticky Tag)

The best way to handle QA and Production environments is to use Sticky Tag feature of KernelCare activation keys issued from CloudLinux Network (CLN) portal.

To use this tag, go to CLN portal → KernelCare tab → click a key to edit → click Edit Key.

You should provide a separate key for each environment and set them to a particular sticky tag which is actually the date to which all the servers in an environment have to be patched.

The date in Sticky tag field can be any date from May 28, 2018 up to one day before today.

To use Sticky Tag feature on the servers to be patched, run:

/usr/bin/kcarectl --set-sticky-patch=KEY

Alternatively, you can do the same by adding STICKY_PATCH=KEY to /etc/sysconfig/kcare/kcare.conf file.

When the Sticky Tag feature is enabled for particular servers, all such servers will get patches only released before the date specified in the Sticky tag field.

This way, you can add new patches to all the servers in some environment (i.e. registered with the same KernelCare license key) by updating only a single field in the CLN portal.

# KernelCare Monitoring

Find more details in KernelCare documentation

# Imunify360 License Types

Click Imunify360 at the top menu to go to Imunify360 License Types page.

Here you can see all available license types, buy and manage them.

The following license types are available:

• Single User — good for servers with only one user in the system
• Up to 30 users — good for servers with users quantity less than 30 or equal
• Up to 250 users — good for servers with users quantity less than 250 or equal
• Unlimited — good for servers with users quantity more than 250 To buy desired license type, click Buy server licenses button. You will be redirected to Purchase page.

A license card includes the following information:

• Server licenses — activated/limit;
• Activation key itself. To copy activation key to clipboard, click it.

The following actions are available to manage a license.

• Add server license — click Add server license button, you will be redirected to Purchase page.
• Remove unused server licenses — click Remove unused server licenses to delete all server licenses that are not used to activate a server. Do it to reduce your monthly bill as a customer pays per each server license and NOT per an activated server. Confirm your action in the opened popup by clicking Remove or click Cancel to close the popup.

• Manage servers — click Manage servers button. You will be redirected to Billing → Overview → Products page.
• Manage activation keys — click Manage Activation keys. You will be redirected to Imunify360 Activation Keys page.

# Imunify360 Activation Keys

Click Imunify360 at the top menu, then click Activation Keys on the left menu to go to Imunify360 Activation Keys page.

Here you can see the table with a list of all Imunify360 Activation Keys. It contains the following columns:

• Activation key — activation key string. Click activation key to go to Activation Key Details page.
• License type — a type of Imunify360 license for certain key. See all available license types.
• IP range — a range of IP addresses for a particular activation key;
• Note — any information you've added to a particular activation key;
• Servers (used/limits) — shows how many servers have already been activated with this key (used) and a total number of servers that can be activated with this key (limits).

The following actions are available:

• filter keys by server limits — click Server Limits and choose a desired number or unlimited;
• filter keys by license type — click License Type and tick desired type(s);
• search for an activation key — type a search query and the table will filter a list of keys;
• delete one or several activation keys — tick one or several activation keys, or the checkbox in the table header (to select all) and click Bin icon. On the popup click Remove to confirm the action or Cancel to close popup.

# Imunify360 License Type Activation Keys

Click Imunify360 at the top menu then Activation Keys → desired type of license (Single User, Up to 30 users, Up to 250 users, Unlimited) on the left menu to go to Imunify360 License Type Activation Keys.

This page contains the following information:

• An activation key itself is displayed on a blue background; to copy it to a clipboard just click it.
• Server licenses (used/limits) — shows how many servers have already been activated with this key (used) and a total number of servers that can be activated with this key (limits).

The following actions are available:

• Generate a new activation key — click Generate new activation key. Create activation key popup opens. Set number of servers to be activated with this key or tick unlimited. Enter some notes, if any. Click Save Changes to generate a new key or Cancel to close the popup. The new generated key is displayed in the table.
• Manage servers — click Manage servers button, you will be redirected to Billing → Overview → Products page.
• Add server licenses — click Add server licenses, you will be redirected to Purchase page.
• Remove unused server licenses — click Remove unused server licenses to delete all server licenses that are not used to activate a server. Do it to reduce your monthly bill as a customer pays per each server license and NOT per an activated server. Confirm your action in the opened popup by clicking Remove or click Cancel to close the popup.

Below, there is a table with all activation keys. The table contains the following columns:

• Activation key — click activation key string to go to Activation Key Details page.
• License Type — a type of Imunify360 license (Single User, Up to 30 users, Up to 250 users, Unlimited).
• IP Range — a range of IP addresses for a particular activation key.
• Note — any notes to a particular activation key.
• Servers (used/limits) —  a number of servers that have already been activated with this key (used) and a total number of servers that can be registered with this particular key (limits).

The following actions are available:

• Filter keys list by server limits. Click Server Limits and specify a number of servers or tick Unlimited.
• Filter keys list by license type. Click License Type and tick desired types.
• Search in the list by a specific query. Type a search query in the search field to show specific keys.
• Remove activation key. Tick key(s) and click Bin icon above the table. The Remove popup opens. Confirm the action by clicking Remove or click Cancel to close the popup.

# Imunify360 Activation Key Details Page

On the Imunify360 Activation Keys page click an activation key string in the table to go to Imunify360 Activation Key Details page.

This page contains the following information:

• An activation key itself is displayed on a blue background; to copy it to a clipboard just click it;
• Servers (used/limits) — a number of servers that have already been activated with this key (used) and a total number of servers that can be registered with this particular key (limits);
• Note — any information you’ve added to this activation key.

The following actions are available:

• Edit key. Click Edit Key button. In the opened popup you can change a number of servers that can be activated with this key and enter some notes. To apply changes, click Save Changes or Cancel to close the popup.
• Remove key. Click Remove Activation Key button. In the opened popup click Remove to apply changes or Cancel to close the popup.

Below, there is a table with all servers activated with this activation key. The table contains the following columns:

• Server name — a hostname of the server.
• IP — an IP address of the activated server.
• Registered — a date when a server was activated. A server sends this information to CLN.
• Last check-in — the date of the last successful server check-in.

The following actions are available:

• Filter servers list by the date of registration. Click Registered Date and select a date or a period to show servers registered within selected period or date.
• Search in the list by specific query. Type a search query in the search field to show specific servers.
• Remove a server from this activation key. In this case, a server will not be protected by Imunify360 anymore. To do that, tick server(s) and click Bin icon above the table.

# Imunify Email Notifications

# Subscription-based customers

Starting from the 1st of June 2024, you will be billed for the Imunify Email service. Imunify Email costs 10% of your Imunify360 license. The billing will be based on whether the 'enabled' feature for Imunify Email is activated on your CLN account. This 'enabled' state indicates that the Imunify Email product is installed on your server. So, if the feature is turned on, you'll be billed accordingly.

You can enable Imunify Email on 3 levels:

1. Account

• When you enable the feature on an account level, the script will install Imunify Email on all Imunify360 servers in your account in 24 hours. You can also run imunify360-agent update-license command to speed up the process.
• When disabling the feature on an account level, the script will deactivate the Imunify Email on all Imunify360 servers in your account in 24 hours.
• There's also a default option called 'depends on lower level'. This allows you to control permissions based on each key or license, rather than for the whole account.

2. Key

You can manage permission on a key level. Go to the 'Activation keys' tab and select 'add-ons'.

You will see this screen:

• When you enable the feature on all servers in the key, the script will install Imunify Email on all Imunify360 servers under this key in 24 hours. You can also run imunify360-agent update-license command to speed up the process.
• When disabling the feature on a key level, the script will deactivate the Imunify Email on all Imunify360 servers under this key in your account in 24 hours.
• There's also a default option called 'depends on lower level'. This allows you to control permissions based on each server.

3. Server

You can manage permission on a server level. Go to the 'Servers' tab and select 'add-ons'.

You will see this pop-up:

• When you enable the feature, the script will install Imunify Email on this server. You can also run imunify360-agent update-license command to speed up the process.
• When disabling the feature, the script will deactivate the Imunify Email on a server in 24 hours.

As a beta tester, you have the feature Imunify Email installed on your servers. We've noticed this and have activated an additional feature related to Imunify Email on all servers where we found it installed. However, you have the flexibility to modify this setting if you wish.

# Usage-based customers

Starting from the 1st of July 2024, you will be billed for the Imunify Email service for the usage in June. Imunify Email costs 10% of your Imunify360 license. The billing will be based on whether the 'enabled' feature for Imunify Email is activated on your CLN account. This 'enabled' state indicates that the Imunify Email product is installed on your server. So, if the feature is turned on, you'll be billed accordingly.

You can enable Imunify Email on 3 levels:

1. Account

• When you enable the feature on an account level, the script will install Imunify Email on all Imunify360 servers in your account in 24 hours. You can also run imunify360-agent update-license command to speed up the process.
• When disabling the feature on an account level, the script will deactivate the Imunify Email on all Imunify360 servers in your account in 24 hours.
• There's also a default option called 'depends on lower level'. This allows you to control permissions based on each key or license, rather than for the whole account.

2. Key

You can manage permission on a key level. Go to the 'Activation keys' tab and select 'add-ons'.

You will see this screen:

• When you enable the feature on all servers in the key, the script will install Imunify email on all Imunify360 servers under this key in 24 hours. You can also run imunify360-agent update-license command to speed up the process.
• When disabling the feature on a key level, the script will deactivate the Imunify email on all Imunify360 servers under this key in your account in 24 hours.
• There's also a default option called 'depends on lower level'. This allows you to control permissions based on each server.

3. Server/ IP license You can manage permission on a server level. Go to the 'Servers' tab and select 'add-ons'.

IP Licenses

You will see this pop-up:

• When you enable the feature, the script will install Imunify email on this server. You can also run imunify360-agent update-license command to speed up the process.
• When disabling the feature, the script will deactivate the Imunify email on a server in 24 hours.

You can also use our API to manage Imunify Email add-on: https://docs.cloudlinux.com/cloudlinux_rest_api.pdf

As a beta tester, you have the feature Imunify Email installed on your servers. We've noticed this and have activated an additional feature related to Imunify Email on all servers where we found it installed. However, you have the flexibility to modify this setting if you wish.

# ELS Activation Keys

# CloudLinux Backup

Available only if CLoudLinux Backup is purchased and activated.

Click CL Backup in the main header menu to go to CloudLinux Backup page. Here you can see a table with all your backups for CloudLinux products.

The table includes the following columns:

• Server name — a name of the server with backup
• Server IP —  displays the IP of the server with backup
• Region —  server location
• Used, GB — backup space used in GB
• Total, GB — total backup space in GB
• Actions:
  • Edit —  click to manage the backup. In the opened popup click Go to the backup management, the backup management application opens in a new tab
  • Resize — click to change the backup space. In the opened popup add or remove the Gbs and click Resize to apply or Cancel to close the popup.
  • Deactivate — click to remove the backup.

  Note

  Backup files cannot be restored after deactivation.

  In the opened popup confirm the action by clicking Remove or click Cancel to close the popup.
  • Relink —  for a backup not associated with a server. Click to connect a backup to a specific server. Confirm the action in the popup or click Cancel to close the popup.

# Servers

Click Dashboard → Servers to go to All Servers page. A list of all servers with activated products belonged to this account is available.

The table includes all servers that have been activated in all products within the account. The table contains the following columns:

• Server name — server hostname;
• IP — server IP address;
• Installed products — shows a logo of a product activated on a server.

Click a server name to show server details:

• Product and activation key used to register that server
• Registered — a date when a server was activated. A server sends this information to CLN
• Last check-in — the last date when a server successfully responded to check-in
• Effective Kernel — displays the version of kernel used (only for KernelCare). Click the version to go to https://patches.kernelcare.com/
• Change License Type —  allows to change the type of the Imunify360 license (only for Imunify360). Click Change License Type to open change popup specify a new license type. Confirm the action by clicking Change or click Cancel to close the popup.

The following actions are available:

• Filter by product — click Product button and select one or more products;
• Filter by date of registration — click Registered date to display a calendar where you can pick a date or a period to filter by.
• Filter by any search query — type a query. A search is performed in Server name and Activation key entities.
• Buy server license — click Buy Server Licenses button, you will be redirected to the Purchase page.

# Server groups

The Server groups feature allows you to add servers in one group and perform global actions on this group (and thereby on all servers included in this group).

# How to create a group

• Go to Servers and select a required product, then click Manage server groups

  

• Click Create your first group or Create new group

  

• Type a group name and description if needed

  

• Then click Save to apply changes or click Cancel to close the popup.

• Close the popup.

# How to remove a group

• Go to Servers and click Manage server groups

  

• Select a group and click Bin ()

• When the group is removed you can close the popup

# How to add a server to a group

• Go to Servers and select a required product. Click in the Group column.

  

• Choose a group from the list or create a new one by typing its name

  

• Click Add to group to apply changes or click Cancel to close the popup

• You will see that the server is added to the group

  

• Or for group action, select servers in the list and click Add to server group.

  

# How to remove a server from a group

• Go to Servers and click Manage server groups

  

• Scroll to Servers and click for a server to be removed from the group

  

• Then click Save to apply changes or click Cancel to close the popup

• Close the popup

# How to move a server from one group to another

• Go to Servers, select server(s) in the list and click Add to server group

  

• Choose a group or create a new one and click Add to group

  

• The server(s) will be moved to another group

# AccelerateWP Features Management for Regular Customers

The Accelerate WP Premium and CDN permission management will help you enable/ disable Premium and CDN features on certain servers. In cases where hosting users have root access to the server (e.g. VPS users), this permission ensures the license holder retains control over access to billable features.

Default state for Cloudlinux OS editions:

• Solo, Admin - disabled
• Pro - enabled

For managing these features via CLN:

1. Login to the CLN account

2. Go to the 'CloudLinux' tab

3. Press a key when you want to enable/ disable Premium or CDN

4. Press Edit key

5. Choose new permissions

6. Save permissions

Permission will apply to all registered under these key servers.