Accessing the UI 

The URL used to access the Storage UI depends on where it is installed. See https://perifery.atlassian.net/wiki/spaces/public/pages/2443810037 to determine the starting URL.

A prompt to log in appears upon reaching the UI. User logins for the UIs are not Swarm-managed but rather LDAP, PAM, or SAML, as configured by the Gateway IDSYS (See https://perifery.atlassian.net/wiki/spaces/public/pages/2443816807).

How the login screen appears depends on whether single sign-on is enabled:

Without Single Sign-On	With Single Sign-On

Without Single Sign-On

With Single Sign-On

Open Host - Read-only. The host name or IP address of the Swarm storage cluster to be viewed.

Open User Name - The user name to be used to sign in through an existing third-party account, such as through OneLogin, Okta, or Google. Users are redirected to the other site to enter the password, and then are redirected back to the Swarm UI when clicking Login with SSO. The login typically expires in one day. For SSO setup, see https://perifery.atlassian.net/wiki/spaces/public/pages/2443816877. (v3.0)

Navigating the UI

Chose which Swarm UI to use (Storage or Content) upon logging in:

Click the top of the site map (the DataCore Swarm logo) to return to this page at any time to navigate to the other UI:

The primary navigation for the Swarm UI is in the left side navigation pane, which includes 3 major sections:

• Cluster: provides access to the details of the cluster's hardware (physical chassis), subclusters (if any), and feeds (search and replication).

• Reports: includes valuable real time and historical views in to the health of and activity in the cluster.

• Settings: displays cluster-wide settings and license information. 

The left pane can be opened and collapsed using the stacked bar icon next to the DataCore Swarm logo.

Throughout the application, quick access links to relevant reports and pages can be accessed through icons on each page. The Health section of the Dashboard includes a link to the more detailed Health Report.

Resources

Located at the top right of the Storage UI is the account name, which drops down a menu of resources:

• Log Out - Ends the current session

• About - Reports the version of the software in use with links to the end user license agreement and third-party licenses

• Support - Opens the Support site (requires an account for full access)

• Documentation - Opens searchable online help

• Language - Allows selection of an alternate display language for the user interface

Rebranding the UI

Use the 'custom' folder that comes with Swarm UI and overwrite the included files to update the UI look and feel for the organization.

1. Place all custom files, SVGs, and style sheets into this 'custom' directory.

2. Replace the images provided or create new images and update the style sheet to reflect any naming changes.

3. Uncomment custom.css for the styling updates to work. 

Create the custom folder at the top level of the installed JavaScript files, alongside such folders as app, fonts, scripts, styles if the folder does not exist.