Studio Overview

Studio, the server's GUI, is installed along with the server. You can connect to it using your browser to access and manage the server.

Connecting your browser to Studio is different when the server you attempt to access is secure and when it isn't.

Connecting to an Unsecure server:

When connecting to an unsecure server, no certificate is required and Studio can be directly connected using the server's URL.

Connecting to a Secure server:

To connect to a secure server, the browser is required to own a client certificate with admin privileges.
Trying to connect to a secure server without a certificate will fail.

Where should the certificate be located?

Certificates must be installed where the browser can find them.

• If you generate a Let's Encrypt certificate during setup, the certificate will be automatically registered in the browser's default location. This location is browser-specific:
  Edge looks for certificates in the OS root store.
  Firefox looks for certificates in the browser's root store.
  Chrome version 105 and up also looks for certificates in the browser's root store.

• If you obtain the certificate elsewhere, you need to ensure that it is properly registered where your browser can find it.
  

  To register a certificate for Firefox or Chrome, you may need to explicitly import the certificate into the browser's root store.
  

• Open the Cluster Dashboard from Studio's main menu.
• A Let's get started widget makes for a great starting point If you are new to RavenDB or this is a fresh setup.
  You can use it to set your cluster, create a first database, or learn about basic database features.
• The dashboard is fully customizable, allowing you to easily add, remove, and rearrange your diagnostics widgets so any visit to this view would reveal precisely the information you're interested in.

Cluster Dashboard

To access your server's configuration and debugging options, open the Manage Server menu from Studio's main menu.

Main menu: Click to manage server

The menu's Cluster option, for example, will allow you, among other options, to add your server to a cluster, see and change its role as a cluster node, and assign it CPU cores.

Manage Server menu: Cluster view

Access the Databases View from Studio's main menu.

This is where databases can be easily created or deleted, and where you can view a concise summary of database metrics and perform operations like disabling or enabling a database or modifying its database group.

Databases view

Header and Footer areas

1. Header area
   • A. Database selector
     Click from different Studio views to select a database.
   • B. Search bar
     Search for an entity in the selected database.
   • C. UI theme selector
     Select the UI theme that suits you.
   • D. Send Feedback
     Click to send us feedback or view issues we're already aware of.
   • E. Notification center
     See and dismiss notifications.
2. Footer area
   • A. Number of Documents in the selected database
   • b. Number of Indexes
   • C. Number of Stale indexes
   • D. Database Authentication status
   • E. Local Node tag
     Click to observe and configure another cluster node.
   • F. Studio version
   • G. Server version
   • H. License information
   • I. Support information
   • J. RavenDB Community