Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renew studio overview page, replace obsolete server-dashboard page with a manage-server page #1980

Merged
merged 3 commits into from
Feb 11, 2025
Merged

Renew studio overview page, replace obsolete server-dashboard page with a manage-server page #1980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b88112d
Updated Studio Overview for RavenDB 6.2 and 7.0
reebhub Feb 5, 2025
f583d54
replaced the obsolete studio/server/server-dashboard page with a mana…
reebhub Feb 7, 2025
0d943ee
rearranged the Studio overview "Accessing Studio After Setup" panel a…
reebhub Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
Binary file modified ....1/Raven.Documentation.Pages/start/installation/images/setup/setup-wizard-1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed ...on.Pages/start/installation/images/setup/snag/Restart-server-after-IP-setup.png
View file
Open in desktop
Binary file not shown.
Binary file modified ...on/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snag
View file
Open in desktop
Binary file not shown.
Binary file added ...n/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snagx
View file
Open in desktop
Binary file not shown.
84 changes: 48 additions & 36 deletions ...entation/5.1/Raven.Documentation.Pages/start/installation/setup-wizard.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ appearing:

{PANEL:Select Setup Mode}

* When running the RavenDB server for the first time,
you will be redirected to the setup wizard welcome page where you can choose your preferred option.
When running the RavenDB server for the first time, you will be redirected
to the setup wizard welcome page where you can choose your preferred option.

![Figure 1. Welcome Page](images/setup/setup-wizard-1.png "Select Mode in the Welcome Page")
![Welcome Page](images/setup/setup-wizard-1.png "Select Mode in the Welcome Page")

{PANEL/}

Expand Down Expand Up @@ -100,11 +100,11 @@ After choosing the Let's Encrypt Secure Setup option, you are required to enter
address you provided. This process will associate your license with the chosen subdomain to ensure that valid certificates can
only be generated by a single license holder.

![Figure 2. Enter License](images/setup/3.png "Enter License")
![Enter License](images/setup/3.png "Enter License")

The next step is to name and claim your subdomain.

![Figure 3. Claim Domain](images/setup/4.png "Claim Domain")
![Claim Domain](images/setup/4.png "Claim Domain")

---

Expand All @@ -131,7 +131,7 @@ server after configuring.

In the following screenshot, we show an example of constructing a cluster for local development on one machine:

![Figure 4. Configure Cluster](images/setup/5.png "Configure Cluster")
![Configure Cluster](images/setup/5.png "Configure Cluster")

All 3 nodes will run on the local machine:

Expand Down Expand Up @@ -169,7 +169,7 @@ from the outside world. Requests made to the external IP address will be forward

Check the box "Customize external IP and Ports" and supply the external IP address.

![Figure 4a. Configure Cloud Node](images/setup/5a.png "Configure Cloud Node")
![Configure Cloud Node](images/setup/5a.png "Configure Cloud Node")

<br/>

Expand All @@ -184,7 +184,7 @@ So if a container was created using:

Then the following configuration should be applied:

![Figure 4b. Configure Docker Node](images/setup/5b.png "Configure Docker Node")
![Configure Docker Node](images/setup/5b.png "Configure Docker Node")

<br/>

Expand All @@ -202,7 +202,7 @@ In some scenarios you will run the setup wizard again. In that case, if none of
cached certificate and not request a new one from Let's Encrypt.
{WARNING/}

![Figure 5. Finishing Up](images/setup/6.png "Finishing Cluster IP Configuration")
![Finishing Up](images/setup/6.png "Finishing Cluster IP Configuration")

{INFO: Configuration Failure}

Expand All @@ -222,7 +222,7 @@ Save this .zip file in each of your server folders. It has the security certific
You may need it in the future, so make sure it is saved in a permanent location.
If you are setting up a cluster, you will use this Zip file to set up the other nodes.

![Figure 6. Configuration Completed](images/setup/7.png "Configuration Completed Image")
![Configuration Completed](images/setup/7.png "Configuration Completed Image")

Copy the downloaded `<YourDomainName>.Cluster.Settings.zip` folder into the Cluster Parent folder(s) to use it later.
It contains the certificate and configurations of the server that you set up in the wizard.
Expand All @@ -234,7 +234,7 @@ cause a 'System.InvalidOperationException: Unable to start the server.' error.
If you must move your folder at a later time, you can [reconfigure the certificate file path](../../server/security/authentication/certificate-configuration#standard-manual-setup-with-certificate-stored-locally)
in the `settings.json` file.

![Figure 6a. Save Cluster Settings Zip in Parent Folder](images/setup/Cluster-Settings-Zip-In-Parent-Folder.png "Save Cluster Settings Zip in Parent Folder")
![Save Cluster Settings Zip in Parent Folder](images/setup/Cluster-Settings-Zip-In-Parent-Folder.png "Save Cluster Settings Zip in Parent Folder")

If you left the "Automatically register the admin client..." box in the IP setup stage checked (it is checked by default),
a client certificate is registered in the OS trusted store during setup. The Chrome and Edge browsers use the OS store,
Expand All @@ -256,16 +256,20 @@ B. Run the `admin.client...pfx` file to start the client certificate import wiz
`cluster.server...pfx`.
Unless you want to set a client certificate password or
define a different file path, you can use the default settings by clicking **next** every time.
![Figure 7. Certificate Import Wizard](images/setup/Certificate-Import-Wizard.png "Certificate Import Wizard")

![Certificate Import Wizard](images/setup/Certificate-Import-Wizard.png "Certificate Import Wizard")

C. In the main installation wizard on your browser, there should be a screen with a **restart** button.
![Figure 7a. Restart server after IP setup](images/setup/Restart-server-after-IP-setup.png "Restart server after IP setup")

![Restart server after IP setup](images/setup/Restart-server-after-IP-setup.png "Restart server after IP setup")

D. After clicking restart, the wizard checks if you've run the certificate Import Wizard, which you've just done.
![Figure 7b. Restart Certificate Wizard Check](images/setup/Cert-Wizard-Check.png "Certificate Wizard Check")

![Restart Certificate Wizard Check](images/setup/Cert-Wizard-Check.png "Certificate Wizard Check")

E. You should see a window that asks which certificate you want to use.
![Figure 7c. Choose certificate](images/setup/8.png "Choose Certificate")

![Choose certificate](images/setup/8.png "Choose Certificate")

---

Expand All @@ -281,7 +285,7 @@ When you access the Studio (automatically opens when starting a RavenDB server)
**Manage Server** tab on the left side > select **Cluster**.
You will see something similar to this:

![Figure 8. Incomplete Cluster](images/setup/9.png "Incomplete Cluster view")
![Incomplete Cluster](images/setup/9.png "Incomplete Cluster view")

Nodes B and C are not running yet. As soon as we start them, Node A will detect and add them to the cluster.

Expand All @@ -290,15 +294,19 @@ Nodes B and C are not running yet. As soon as we start them, Node A will detect
1. Extract the downloaded server `RavenDB...zip` folder into the Node B folder.
2. In **Windows**, start the RavenDB setup wizard using the `run.ps1` script via PowerShell. In **Linux**, use the `start.sh` script.
3. **Continue the cluster setup for new node**
This time we will scroll down and click the "Continue the cluster setup for new node" button to connect other servers to this cluster.
![Figure 9. Choose Cluster Setup](images/setup/10.png "Choose Cluster Setup view")
This time we will scroll down and click the "Continue the cluster setup for new node" button to connect other servers to this cluster.

![Choose Cluster Setup](images/setup/10.png "Choose Cluster Setup view")

4. If on separate machines, run the `admin.cluster...pfx` file on the new machine to register the certificate in the OS.
5. **Configuration package**
In the Setup Wizard (image below), **Browse** for and select the `<YourDomainName>.Cluster.Settings.zip` file from setup folder.
6. **Node Tag**
Select node tag (B in this case) to designate which node in the cluster this server will be.
7. Then click **next**.
![Figure 10. Complete Existing Cluster](images/setup/Complete-Existing-Cluster-Setup.png "Complete Existing Cluster view")

![Complete Existing Cluster](images/setup/Complete-Existing-Cluster-Setup.png "Complete Existing Cluster view")

8. Click **Restart**. A new tab with the Studio should open in your browser and when you navigate to: Manage Server -> Cluster you should
see two green nodes with a green line between them.
9. Repeat the process for the remaining nodes. When all the nodes are up, you can view the updated topology in the Studio.
Expand All @@ -310,7 +318,7 @@ Nodes B and C are not running yet. As soon as we start them, Node A will detect

{NOTE/}

![Figure 11. Healthy Cluster](images/setup/12.png "Healthy Cluster")
![Healthy Cluster](images/setup/12.png "Healthy Cluster")

</br>

Expand Down Expand Up @@ -387,7 +395,7 @@ cluster nodes as "Subject Alternative Names" (SANs).
After choosing the Secure Setup with your own certificate option, you are required to upload the certificate and click next.
In the example, we will use the *.ravendb.example.com wildcard certificate.

![Figure 1. Upload Certificate](images/setup/w1.png "Upload Certificate")
![Upload Certificate](images/setup/w1.png "Upload Certificate")

### Configuring The Server Addresses

Expand All @@ -412,7 +420,7 @@ If you are running behind a firewall, the DNS records must point to the **extern

In the following screenshot, we show an example of constructing a cluster for local development on one machine:

![Figure 2. Configure Cluster](images/setup/w2.png "Configure Cluster")
![Configure Cluster](images/setup/w2.png "Configure Cluster")

All 3 nodes will run on the local machine:

Expand Down Expand Up @@ -461,7 +469,7 @@ So if a container was created using:

Then the following configuration should be applied:

![Figure 2a. Configure Docker Node](images/setup/w2a.png "Configure Docker Node")
![Configure Docker Node](images/setup/w2a.png "Configure Docker Node")

{NOTE: }

Expand All @@ -473,7 +481,7 @@ Usually, the solution is to wait a few minutes and try again. If you do not want
When finished, you will receive a Zip file containing all of the cluster configuration settings files.
If you are setting up a cluster, you will use this Zip file to set up each of your nodes.

![Figure 3. Configuration Completed](images/setup/w3.png "Configuration Completed")
![Configuration Completed](images/setup/w3.png "Configuration Completed")


{NOTE/}
Expand Down Expand Up @@ -503,7 +511,7 @@ RavenDB will accept `.pfx` server certificates which contain the private key, ar
* If you unchecked the box, before you continue please [register the client certificate](../../server/security/authentication/client-certificate-usage)
in the OS store or import it to the browser.

![Figure 4. Restart and choose certificate](images/setup/w4.png "Restart and choose certificate")
![Restart and choose certificate](images/setup/w4.png "Restart and choose certificate")

If you are setting up a single node, the setup is complete and you can start working.

Expand All @@ -514,7 +522,7 @@ If you are setting up a single node, the setup is complete and you can start wor
When you access the Studio (automatically opens when starting a RavenDB server) check that Node A is running by clicking the
**Manage Server** tab on the left side > select **Cluster**.

![Figure 8. Incomplete Cluster](images/setup/w5.png "Incomplete Cluster")
![Incomplete Cluster](images/setup/w5.png "Incomplete Cluster")

Nodes B and C are not running yet. As soon as we start them, node A will detect it and add them to the cluster.

Expand All @@ -523,15 +531,19 @@ Nodes B and C are not running yet. As soon as we start them, node A will detect
1. Extract the downloaded server `RavenDB...zip` folder into the Node B folder.
2. In **Windows**, start the RavenDB setup wizard using the `run.ps1` script via PowerShell. In **Linux**, use the `start.sh` script.
3. **Continue the cluster setup for new node**
This time we will scroll down and click the "Continue the cluster setup for new node" button to connect other servers to this cluster.
![Figure 9. Choose Cluster Setup](images/setup/10.png "Choose Cluster Setup view")
This time we will scroll down and click the "Continue the cluster setup for new node" button to connect other servers to this cluster.

![Choose Cluster Setup](images/setup/10.png "Choose Cluster Setup view")

4. If on separate machines, run the `admin.cluster...pfx` file on the new machine to register the certificate in the OS.
5. **Configuration package**
In the Setup Wizard (image below), **Browse** for and select the `<YourDomainName>.Cluster.Settings.zip` file from setup folder.
6. **Node Tag**
Select node tag (B in this case) to designate which node in the cluster this server will be.
7. Then click **next**.
![Figure 10. Complete Existing Cluster](images/setup/Complete-Existing-Cluster-Setup.png "Complete Existing Cluster view")

![Complete Existing Cluster](images/setup/Complete-Existing-Cluster-Setup.png "Complete Existing Cluster view")

8. Click **Restart**. A new tab with the Studio should open in your browser and when you navigate to: Manage Server -> Cluster you should
see two green nodes with a green line between them.
9. Repeat the process for the remaining nodes. When all the nodes are up, you can view the updated topology in the Studio.
Expand All @@ -543,7 +555,7 @@ Nodes B and C are not running yet. As soon as we start them, node A will detect

{NOTE/}

![Figure 11. Complete Cluster](images/setup/w7.png "Complete Cluster")
![Complete Cluster](images/setup/w7.png "Complete Cluster")

You have successfully finished setting up a secure cluster of RavenDB servers using your own wildcard certificate.

Expand Down Expand Up @@ -616,7 +628,7 @@ In the **Unsecure Mode**, all you need to do is specify the **IP address** and *
* Anyone who can access the server using the configured IP address will be granted **administrative privileges**.
{DANGER/}

![Figure 1. Complete Cluster](images/setup/u0.png "Configuring a server on Node A, listening to 127.0.0.1 on port 8080 ")
![Complete Cluster](images/setup/u0.png "Configuring a server on Node A, listening to 127.0.0.1 on port 8080")

1. **Http Port** - Enter the port that will be used by the clients and the Studio. Default is 8080.
**TCP Port** - Enter the port that will be used for inter-server communication and for subscriptions. Default is 38888.
Expand All @@ -638,13 +650,13 @@ In the **Unsecure Mode**, all you need to do is specify the **IP address** and *

5. **Next** - Click Next when done configuring.

![Figure 2. Complete Cluster](images/setup/u1.png "Configuration has completed - Restart the Server")
![Complete Cluster](images/setup/u1.png "Configuration has completed - Restart the Server")

Once configuration is completed, restart the server.
After a few seconds, the server will be ready and accessible.
Access the Studio by entering the URL in the browser: "http://127.0.0.1:8080" or "http://localhost:8080".
Once the configuration is completed, restart the server.
After a few seconds, the server will be ready and accessible.
Access the Studio by entering the URL in the browser: "http://127.0.0.1:8080" or "http://localhost:8080".

![Figure 3. Complete Cluster](images/setup/u2.png "The server's dashboard")
![Complete Cluster](images/setup/u2.png "The server's dashboard")

### Continuing The Cluster Setup

Expand Down
8 changes: 7 additions & 1 deletion Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
8 changes: 7 additions & 1 deletion Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
"Path": "server-dashboard.markdown",
"Name": "Server Dashboard",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
"LastSupportedVersion": "6.0",
"Mappings": [
{
"Version": 6.2,
"Key": "studio/server/manage-server"
}
]
},
{
"Path": "client-configuration.markdown",
Expand Down
Binary file added .../Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...tion/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx
View file
Open in desktop
Binary file not shown.
Binary file added ...6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...ntation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx
View file
Open in desktop
Binary file not shown.
Binary file added ...tion/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx
View file
Open in desktop
Binary file not shown.
Binary file added ...ntation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx
View file
Open in desktop
Binary file not shown.
Binary file added ...tion/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx
View file
Open in desktop
Binary file not shown.
Binary file added ...Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...ion/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx
View file
Open in desktop
Binary file not shown.
Loading
Loading