See also Content UI Release Notes and Swarm Content UI (usage guide).

System Requirements

Hardware

The Content UI does not require additional hardware. Install the Content UI on every Gateway server that serves users who access the content.

Exception

Need to install the Content UI on a Gateway subset if the subset in a load balancing group is reserved for external access (where Content UI access is not required).

Swarm

Swarm Storage must be ready:

Be configured to support Gateway
Have a Search feed configured and running

Gateway

One or more Gateway servers must be ready:

Be correctly configured and started
Have the SCSP protocol configured for external access
Have idsys.json and policy.json files set for authentication and authorization (see Content Gateway Authentication and Gateway Installation)

Browser

The Content UI requires a JavaScript-enabled internet browser.

note

Note

Use the recent versions of Firefox and Chrome for testing and development.

Note

Use the recent versions of Firefox and Chrome for testing and development.

Installing the Content UI

Important

Any Gateway server on which the Content UI is being installed must be configured with SCSP enabled.

Install and configure Gateway.
Verify all storage domains have DNS entries to access them from the Content UI.
Navigate to the directory where Gateway was unzipped.

Install the Content UI.

yum install caringo-gateway-webui-{version}.rpm

Restart the Gateway.
systemctl restart cloudgateway
Navigate to the login page for the Content UI, using the base URL of any storage domain in the cluster on the configured SCSP port:
http://{storage-domain}/_admin/portal/

CloudScaler Portal

The Content UI replaces the legacy CloudScaler Admin Portal. If the old Admin Portal was previously installed on the Gateway server, remove it as it is incompatible:

rm -rf /etc/caringo/cloudscaler/portal

rm /etc/caringo/cloudgateway/web.d/10portal.web.xml

Required Access Policies

The access policy documents control and protect everything visible in the Content UI. A policy that grants access to a particular domain blocks the members from seeing anything (domains, tenants, clusters) outside of the domain for which they are authorized. Set the policies to grant the use of the Content UI as part of the implementation.

Essential Permission

The following essential permissions allow users with no other domain-level permissions to navigate to and view a bucket and objects:

GetDomain is the essential, required permission for all domain users to see the Content UI.
GetBucket is required to display some charts.
ListEtc (List Policies in the UI) is needed to see collections listed.
GetPolicy is needed to open a collection.
GetQuota is required to display some charts.

Listing Permissions

ListDomain is required to list buckets in the domain. It also allows SCSP listings and collections to be listed throughout the domain, regardless of ListBucket permissions.
ListDomains is required to list domains in the tenant.

Important

Use the JSON text editor to add the above action (ListDomains) before Content UI 7.6.0.

ListBucket is required for the listing of objects within a bucket.

See Setting Permissions (Access Policy Editor), Gateway Access Control Policies, and the best practices in Policy Document.
Below is an example of tenant policy:

{
  "Version": "2008-10-17",
  "Id": "Tenant policy granting all authenticated users read-only access throughout tenant.",
  "Statement": [
    {
      "Sid": "1: Actions required by Portal. No GetObject, no CreateDomain.",
      "Effect": "Allow",
      "Principal": {
        "user": [ "*" ]
      },
      "Action": [
        "GetPolicy",
        "GetTenant",
        "GetDomain",
        "GetBucket",
        "ListEtc",
        "ListTenant",
        "ListDomains",
        "ListDomain",
        "ListBucket",
        "GetQuota",
      ],
      "Resource": "*"
    }
  ]
}

Customizing the Content UI

Styling

The Content UI incorporates an empty CSS file used to override the Content UI's styling, both for rebranding purposes and to protect changes across upgrades. The customization stylesheet is css/custom.css.

Info

The custom.css includes instructions for how to replace logos on the login page, headers, and About page.

Help Links

Customize the links for documentation and support on the resource menu:

In a text editor, open /opt/caringo/gateway-webui/customLinks.json
Locate and add URLs for one or both of these properties:

"userDocumentationLink":""
"userSupportLink":""

Reload the Content UI and verify the "Documentation" and "Online Support" links that point to those specified in the JSON file.

Upgrading the Content UI

See Upgrading Gateway and Content Gateway Release Notes for the installed version as the Content UI is upgraded along with Gateway.