Couchbase Web Console

Couchbase Web Console is a browser-based, interactive graphical facility that supports the management of Couchbase Server. This includes:

The range of features made available depends on the roles that have been assigned to the user who logs into the console. If the user has been assigned the Full Administrator role, they have complete access to all features; and can therefore read, write, execute, and manage without constraint. Other roles limit the feature-range. For detailed information, see Roles.

This page provides an overview of the complete feature-set made available by Couchbase Web Console. In many cases, detailed explanations of the user interface is provided elsewhere in the documentation-set, in correspondence with the supported feature. Links are provided in each case.

Couchbase Web Console is typically accessible at port 8091, of the host system, although the port number may be different if secure console-access has been established: see Manage Console Access, for information. When the appropriate port is accessed, the following interface is displayed:

The interface provides two options:

These procedures, which include establishing credentials for administrator-authentication, are described in detail in Create a Cluster. The remaining information on this page assumes that a cluster of one node has been established. The features of the console will be portrayed in their entirety, as visible to the Full Administrator.

Once the cluster is running, all its administrators must authenticate, in order to access its features. Therefore, when port 8091 is accessed by means of the browser, the following interface is displayed:

Enter username and password, and left-click on the Sign In button to access the console.

Detailed information on authenticating with Couchbase Server is provided in Authentication.

On the user’s successful login, the console displays the Dashboard. If this is the user’s first-time access, the appearance is as follows:

The display thus consists of a banner with interactive controls; a main panel, which allows display of data and configuration fields; a left-hand navigation bar, which allows the main panel’s content to be determined; and a lower panel, which displays current status on the cluster. These are described below.

Couchbase Web Console allows users to access features by left-clicking on tabs. Tabs are located:

The remaining sections on this page describe in turn the features accessed by left-clicking on the tabs provided.

Left-click on the Servers tab, in the left-hand navigation bar:

The main panel changes, to display the Servers screen. Its initial appearance is as follows:

The Servers screen provides information on every node in the cluster. In this case, the cluster consists of a single node: therefore, a single row of information is displayed, for the current node. This information includes the following:

Above the server-information row, two additional controls are provided:

To the right-hand side of the banner, three further controls appear:

For an example of the Servers screen with a cluster of multiple nodes, see the three node cluster used in Recover Data with XDCR.

To access the Buckets screen, left-click on the tab in the left-hand navigation bar:

This brings up the Buckets screen, which initially appears as follows:

As with the Dashboard, described above, before any bucket has been added to the server, the Buckets screen is almost blank. A notification is provided, with options to use the Add Bucket control at the upper right, or to Install Sample Buckets, in order to add a bucket containing data that is ready to support testing and experimentation.

After the travel-sample bucket has been added, by means of the procedure described in Install Sample Buckets, the Buckets screen appears as follows:

The Buckets screen displays each bucket on its own row, with supporting information distributed horizontally, in columns. The column headings are:

To the right-hand side of the column, twoe tabs are provided, whereby additional information can be accessed. The Documents tab allows the documents within the bucket to be individually read and edited. This facility can also be accessed by means of the Documents tab, in the left-hand navigation bar; as explained in Documents, below. The Scopes & Collections tab provides access data-containers within the bucket, whereby documents can be organized according to type: for information, see Scopes and Collections.

To access the XDCR screen, left-click on the tab in the left-hand navigation bar:

This brings up the XDCR screen, which initially appears as follows:

XDCR (Cross Data Center Replication) replicates data between clusters, providing protection against data center failure. Replication occurs from a specific bucket on the source cluster to a specific bucket on a target cluster.

In its initial display, the XDCR screen provides a panel named Remote Clusters. This will list the clusters that have been defined as targets for replication. It also provides a panel named Outgoing Replications, which will list the replications that are in process between source and target clusters.

To access the Security screen, left-click on the tab in the left-hand navigation bar:

This brings up the Security screen:

The Security screen can be displayed in four distinct views, each corresponding to a separate area of security-management. These are accessed by means of tabs, distributed across the upper horizontal navigation bar. They are Users and Groups, Certificates, Audit, and Other Settings. For information on these screens, and links to further information on the security features they support, see Manage Security Settings.

To access the Settings screen, left-click on the tab in the left-hand navigation bar:

This brings up the Settings screen:

The Settings screen allows configuration of a variety of important parameters within Couchbase Server. Like the Security screen, it provides multiple views, each corresponding to a separate feature set, and accessed by means of tabs, distributed across the upper horizontal navigation bar. The tabs are General (displayed by default), Auto-Compaction, Alerts, and Sample Buckets.

To access the Logs screen, left-click on the tab in the left-hand navigation bar:

This brings up the Logs screen:

The Couchbase Logging facility records important events, and saves the details to log files, on disk. Additionally, subsets of information are provided on the Logs screen.

The Logs screen offers two views, one of which is the default representation of logged information. The other is a facility for configuring explicit logging, which allows comprehensive and fully updated information to be generated as required.

To access the Documents screen, left-click on the tab in the left-hand navigation bar:

This brings up the Documents screen:

This screen displays the documents contained within installed buckets. The screen is currently blank, since no buckets have yet been installed. The Location control permits a bucket to be selected from those installed, and for a scope and a collection within the bucket to be selected. Other controls allow specific documents to be displayed, according to configured parameters. (For information on scopes and collections, see Scopes and Collections).

The easiest way to install a bucket containing data is described in Install Sample Buckets. If the travel-sample is installed, the screen appears as follows:

The internal content of documents can now be displayed and edited.

The Documents screen presents two separate panels, which are accessible from the horizontal navigation bar along the top. The Workbench panel is the default, currently displayed. A full description of this panel and its contents is provided in Explore the Server Configuration, which is part of the the Getting Started sequence. For an explanation of the Import panel, see Import Documents.

To edit a document, left-click on a document-id that appears in the id column of the Workbench panel. This brings up the Edit Document dialog, which features an interactive Data panel, whereby the document’s contents can be edited:

To examine the document’s metadata, left-click on the Metadata button, at the upper right of the Edit Document dialog. This duly brings up the Metadata panel (which is read only).

For instructions on installing a sample bucket, which contains documents that are ready to be inspected and experimented with, see Install Sample Buckets.

To access the Query screen, left-click on the tab in the left-hand navigation bar:

This brings up the Query screen:

Initially, even though the cluster is running the Query Service, no content may be displayed. Content is presently displayed, provided that the cluster is running the Index Service:

This screen now features the Query Workbench: an interactive tool that lets you compose and execute SQL++ queries on the data contained by the bucket. In its initial display, the tool shows the sequence of SQL++ commands that have been executed to create the scopes and collections within travel-sample: for information, see Scopes and Collections.

To access the Indexes screen, left-click on the tab in the left-hand navigation bar:

This brings up the Indexes screen:

The screen is initially blank, since no buckets have yet been added. If a bucket is defined, and data loaded into it, indexes must then be defined on the data, before they are registered on the Indexes screen. However, sample buckets have data and indexes predefined. The procedure for adding a sample bucket is provided in Install Sample Buckets. After this procedure is followed for the travel-sample bucket, the Indexes screen appears as follows:

Note that initially, the status column provides ongoing figures for mutations remaining: this indicates that the indexes for the bucket are still being prepared. When the indexes have been fully prepared, the mutations remaining notifications are no longer displayed:

To access the Search screen, left-click on the tab in the left-hand navigation bar:

This brings up the Full Text Search screen:

The screen contains panels for Search Indexes and Aliases. Both panels are currently blank, since nothing has yet been created.

Creation of both is explained in Searching from the UI.

To access the Analytics screen, left-click on the tab in the left-hand navigation bar:

This brings up the Analytics screen:

The screen contains an Analytics Query Editor, and a panel for Analytics Query Results. Both panels are currently blank.

To access the Eventing screen, left-click on the tab in the left-hand navigation bar:

This brings up the Eventing screen:

The screen is currently blank, since no Eventing functions have yet been defined.

To access the Backup screen, left-click on the tab, in the left-hand navigation bar:

This brings up the Repositories screen, of the Backup Service:

The screen is currently blank, since no Backup-Service repositories have yet been defined.

To access the Views screen, left-click on the tab in the left-hand navigation bar:

This brings up the Views screen:

The screen is currently blank, since no Views have yet been defined.