diff --git a/Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json index da94838c06..6400adac79 100644 --- a/Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/4.0/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json index 7b9ad955a3..c1c7055918 100644 --- a/Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/4.1/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json index f20150a988..50ab42cc82 100644 --- a/Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/4.2/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json index f20150a988..50ab42cc82 100644 --- a/Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/5.0/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/setup-wizard-1.png b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/setup-wizard-1.png index f022bdbf8a..b51ce6e4ea 100644 Binary files a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/setup-wizard-1.png and b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/setup-wizard-1.png differ diff --git a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/Restart-server-after-IP-setup.png b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/Restart-server-after-IP-setup.png deleted file mode 100644 index 0647fe5f44..0000000000 Binary files a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/Restart-server-after-IP-setup.png and /dev/null differ diff --git a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snag b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snag index 1392f9c5ab..ac02eae120 100644 Binary files a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snag and b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snag differ diff --git a/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snagx b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snagx new file mode 100644 index 0000000000..8041241e50 Binary files /dev/null and b/Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/setup-wizard-1.snagx differ diff --git a/Documentation/5.1/Raven.Documentation.Pages/start/installation/setup-wizard.markdown b/Documentation/5.1/Raven.Documentation.Pages/start/installation/setup-wizard.markdown index f99ed9cf48..13e4b18fc2 100644 --- a/Documentation/5.1/Raven.Documentation.Pages/start/installation/setup-wizard.markdown +++ b/Documentation/5.1/Raven.Documentation.Pages/start/installation/setup-wizard.markdown @@ -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/} @@ -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") --- @@ -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: @@ -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")
@@ -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")
@@ -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} @@ -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 `.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. @@ -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, @@ -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") --- @@ -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. @@ -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 `.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. @@ -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")
@@ -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 @@ -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: @@ -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: } @@ -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/} @@ -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. @@ -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. @@ -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 `.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. @@ -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. @@ -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. @@ -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 diff --git a/Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json index 583ec576c9..31cfec32fe 100644 --- a/Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/5.1/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json index 6b4e98d997..8fa906f194 100644 --- a/Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/5.2/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json index 6b4e98d997..8fa906f194 100644 --- a/Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/5.3/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json index 29c1047444..bdeda0e6f9 100644 --- a/Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/5.4/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json index 29c1047444..bdeda0e6f9 100644 --- a/Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/6.0/Raven.Documentation.Pages/studio/server/.docs.json @@ -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", diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png new file mode 100644 index 0000000000..46772bc7b1 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx new file mode 100644 index 0000000000..f6c8bcdf51 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png new file mode 100644 index 0000000000..2234c8ee78 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx new file mode 100644 index 0000000000..c0db1e9133 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png new file mode 100644 index 0000000000..35eb4da2f2 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx new file mode 100644 index 0000000000..cc819517d5 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.png b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.png new file mode 100644 index 0000000000..4437cd68c9 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx new file mode 100644 index 0000000000..3d3a8a8593 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png new file mode 100644 index 0000000000..9187d41918 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx new file mode 100644 index 0000000000..57a3de5adc Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png new file mode 100644 index 0000000000..b99cef3da0 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx new file mode 100644 index 0000000000..4fe9e65cb2 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/overview.markdown b/Documentation/6.2/Raven.Documentation.Pages/studio/overview.markdown new file mode 100644 index 0000000000..e85e55a3f6 --- /dev/null +++ b/Documentation/6.2/Raven.Documentation.Pages/studio/overview.markdown @@ -0,0 +1,174 @@ +# Studio Overview +--- + +{NOTE: } + +* RavenDB's **Management Studio** is installed along with the server and can + be accessed via any modern browser. + Access Studio using the server's URL, including its port number. E.g.: `http://localhost:8080` + +* Use Studio to manage your RavenDB + [cluster](../studio/cluster/cluster-dashboard/cluster-dashboard-overview), + [servers](../studio/server/manage-server), + and [databases](../studio/database/databases-list-view). + You can observe, modify, and create [indexes](../studio/database/indexes/indexes-overview), + issue [queries](../studio/database/queries/query-view), + adjust [settings](../studio/database/settings/database-settings), + view [statistics](../studio/database/stats/ongoing-tasks-stats/overview) + and [logs](../studio/server/debug/admin-logs), + define [ongoing tasks](../studio/database/tasks/ongoing-tasks/general-info), + [import](../studio/database/tasks/import-data/import-data-file) + and [export](../studio/database/tasks/export-database) data, + and much more. + +* In this page: + * [Accessing Studio After Setup](../studio/overview#accessing-studio-after-setup) + * [Connecting to an Unsecure server](../studio/overview#connecting-to-an-unsecure-server) + * [Connecting to a Secure server](../studio/overview#connecting-to-a-secure-server) + * [Where should the certificate be located](../studio/overview#where-should-the-certificate-be-located) + * [The Cluster Dashboard](../studio/overview#the-cluster-dashboard) + * [Manage Your Server](../studio/overview#manage-your-server) + * [Manage Your Databases](../studio/overview#manage-your-databases) + * [Header and Footer Areas](../studio/overview#header-and-footer-areas) +{NOTE/} + +--- + +{PANEL: Accessing Studio After Setup} + +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. + +{INFO: Secure and Unsecure servers} +When a RavenDB server runs for the first time, it presents its user with +a [setup wizard](../start/installation/setup-wizard#select-setup-mode). +You can use this wizard to select whether to install a **Secure** server +(with a [Let's Encrypt](../start/installation/setup-wizard#secure-setup-with-a-free-let) +or a [self-obtained](../start/installation/setup-wizard#secure-setup-with-your-own-certificate) +certificate) or an [Unsecure](../start/installation/setup-wizard#unsecure-setup) server. +{INFO/} + +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](../start/installation/setup-wizard#unsecure-setup) +server, **no certificate** is required and Studio can be directly connected using +the server's URL. +{WARNING: } +Please be aware that using an unsecure server is **not** recommended except for +experiments in a development environment. +{WARNING/} + +## Connecting to a Secure server: + +To connect to a **secure server**, the browser is required to own a **client certificate** +with [admin privileges](../server/security/authentication/client-certificate-usage). +Trying to connect to a secure server without a certificate +[will fail](../server/security/common-errors-and-faq#authentication-error-occurred-using-edge). + +#### Where should the certificate be located? + +Certificates must be installed where the browser can find them. + +* If you generate a [Let's Encrypt](../start/installation/setup-wizard#secure-setup-with-a-free-let) + 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](https://blog.chromium.org/2022/09/announcing-launch-of-chrome-root-program.html). + +* If you obtain the certificate [elsewhere](../start/installation/setup-wizard#secure-setup-with-your-own-certificate), + you need to ensure that it is properly registered where your browser can find it. + {NOTE: } + To register a certificate for Firefox or Chrome, you may need to + [explicitly import the certificate](../server/security/common-errors-and-faq#authentication-error-occurred-using-chrome) + into the browser's root store. + {NOTE/} + +{PANEL/} + +--- + +{PANEL: The Cluster Dashboard} + +* Open the **Cluster Dashboard** from Studio's main menu. +* A [Let's get started](../studio/cluster/cluster-dashboard/cluster-dashboard-widgets#let) + 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](../studio/cluster/cluster-dashboard/cluster-dashboard-customize), + 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. + +{INFO: } +[Learn more about the cluster dashboard](../studio/cluster/cluster-dashboard/cluster-dashboard-overview) +{INFO/} + +![Cluster Dashboard](images/overview_cluster-dashboard.png "Cluster Dashboard") + +{PANEL/} + +{PANEL: Manage your Server} + +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](images/overview_click-to-manage-server.png "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. + +{INFO: } +[Learn more about the Cluster view](../studio/cluster/cluster-view) +{INFO/} + +![Manage Server menu: Cluster view](images/overview_manage-server_cluster-view.png "Manage Server menu: Cluster view") + +{PANEL/} + +{PANEL: Manage your Databases} + +Access the **Databases View** from Studio's main menu. +![Click to manage databases](images/overview_click-to-manage-databases.png "Click to manage databases") + +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](images/overview_databases-view.png "Databases view") + +{PANEL/} + +{PANEL: Header and Footer Areas} + +![Header and Footer areas](images/overview_header-and-footer.png "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](https://ravendb.net/community) + +{PANEL/} diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/6.2/Raven.Documentation.Pages/studio/server/.docs.json index 29c1047444..3cf99081e5 100644 --- a/Documentation/6.2/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/6.2/Raven.Documentation.Pages/studio/server/.docs.json @@ -1,9 +1,46 @@ [ { - "Path": "server-dashboard.markdown", - "Name": "Server Dashboard", + "Path": "manage-server.markdown", + "Name": "Manage Server", "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34", - "Mappings": [] + "Mappings": [ + { + "Version": 6.0, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 5.4, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 5.3, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 5.2, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 5.1, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 5.0, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 4.2, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 4.1, + "Key": "studio/server/server-dashboard" + }, + { + "Version": 4.0, + "Key": "studio/server/server-dashboard" + } + ] }, { "Path": "client-configuration.markdown", diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/client-configuration.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/client-configuration.png new file mode 100644 index 0000000000..9a55355b58 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/client-configuration.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/client-configuration.snag b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/client-configuration.snag new file mode 100644 index 0000000000..f6afae82fb Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/client-configuration.snag differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.png new file mode 100644 index 0000000000..951ecebd28 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.snagx new file mode 100644 index 0000000000..58b2b0320a Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.png new file mode 100644 index 0000000000..2234c8ee78 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.snagx new file mode 100644 index 0000000000..c0db1e9133 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/manage-server_click-to-manage-server.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_hover-for-explanation-caption.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_hover-for-explanation-caption.png new file mode 100644 index 0000000000..8ceddd22d1 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_hover-for-explanation-caption.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_hover-for-explanation-caption.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_hover-for-explanation-caption.snagx new file mode 100644 index 0000000000..798cc82acb Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_hover-for-explanation-caption.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_list-by-text.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_list-by-text.png new file mode 100644 index 0000000000..2657353f1f Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_list-by-text.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_list-by-text.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_list-by-text.snagx new file mode 100644 index 0000000000..654336159d Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_list-by-text.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_manage-server-section.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_manage-server-section.png new file mode 100644 index 0000000000..60e201040b Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_manage-server-section.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_manage-server-section.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_manage-server-section.snagx new file mode 100644 index 0000000000..9f0230b37b Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_manage-server-section.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_server-settings-view.png b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_server-settings-view.png new file mode 100644 index 0000000000..db9135f1eb Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_server-settings-view.png differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_server-settings-view.snagx b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_server-settings-view.snagx new file mode 100644 index 0000000000..31322b9361 Binary files /dev/null and b/Documentation/6.2/Raven.Documentation.Pages/studio/server/images/server-settings_server-settings-view.snagx differ diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/server/manage-server.markdown b/Documentation/6.2/Raven.Documentation.Pages/studio/server/manage-server.markdown new file mode 100644 index 0000000000..7d0c72f41a --- /dev/null +++ b/Documentation/6.2/Raven.Documentation.Pages/studio/server/manage-server.markdown @@ -0,0 +1,75 @@ +# Studio: Manage Server +--- + +{NOTE: } + +* Use the **Manage Server** menu to access your server's configuration and debugging options. + +* In this page: + * [Manage Server menu](../../studio/server/manage-server#manage-server-menu) + * [Configuration options](../../studio/server/manage-server#manage-server-configuration-options) + * [Debug options](../../studio/server/manage-server#debug-debugging-and-statistics-options) + +{NOTE/} + +--- + +{PANEL: Manage Server menu} + +Open the **Manage Server** menu from Studio's main menu. + +![Main menu: Click to manage server](images/manage-server_click-to-manage-server.png "Main menu: Click to manage server") + +--- + +The menu is divided into two main sections, one to configure various server +options and the second to debug the server and view various statistics. + +![Manage Server menu](images/manage-server.png "Manage Server menu") + +### 1. Manage Server: Configuration options + +* [Cluster](../../studio/cluster/cluster-view) + View and modify your cluster topology. +* [Client Configuration](../../studio/server/client-configuration) + Set a client configuration that applies to all the databases in the cluster. +* [Studio Configuration](../../studio/database/settings/studio-configuration#studio-configuration---server-wide) + Set server-wide Studio-related options, applied to all the databases hosted by this server. +* [Server Settings](../../studio/server/server-settings) + Display settings common to all the databases hosted by this server. +* [Admin JS Console](../../studio/server/debug/admin-js-console) + Use this console to run JavaScript code, to execute advanced operations on the server. +* [Certificates](../../studio/server/certificates/server-management-certificates-view) + Export, Import and Customization options for server and client certificates. +* **Server-Wide Tasks** + Define server-wide + [External Replication](../../studio/database/tasks/ongoing-tasks/external-replication-task) + and [Periodic Backup](../../studio/database/tasks/backup-task) + tasks that apply to all the databases hosted by this server. +* [Server-Wide Analyzers](../../studio/database/settings/custom-analyzers#server-wide-custom-analyzer-view) + Add server-wide custom analyzers, to split index fields into tokens + that can be used by indexes on all the databases hosted by this server. +* [Server-Wide Sorters](../../studio/database/settings/custom-sorters#server-wide-custom-sorter-view) + Add server-wide custom sorters, to define how query results are ordered + by queries made on all the databases hosted by this server. + +### 2. Debug: Debugging and statistics options + +* [Admin Logs](../../studio/server/debug/admin-logs) + View a live stream of RavenDB log data, and modify logging settings. +* **Traffic Watch** + View the HTTP requests made to the server. +* **Gather Debug Info** + Collect diagnostics data from selected or all databases on this + server or the entire cluster, to help troubleshoot and resolve issues. +* **Storage Report** +* **IO Stats** + View, Export, and Import I/O statistics. +* **Stack Traces** + Capture debugging stack traces for this server or the entire cluster. +* **Running Queries** +* **Advanced** + Advanced debug options, including the + [Cluster Observer](../../studio/server/debug/advanced/cluster-observer). + +{PANEL/} diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png new file mode 100644 index 0000000000..46772bc7b1 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx new file mode 100644 index 0000000000..f6c8bcdf51 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-databases.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png new file mode 100644 index 0000000000..2234c8ee78 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx new file mode 100644 index 0000000000..c0db1e9133 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_click-to-manage-server.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png new file mode 100644 index 0000000000..35eb4da2f2 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx new file mode 100644 index 0000000000..cc819517d5 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_cluster-dashboard.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_databases-view.png b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_databases-view.png new file mode 100644 index 0000000000..4437cd68c9 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_databases-view.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx new file mode 100644 index 0000000000..3d3a8a8593 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_databases-view.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png new file mode 100644 index 0000000000..ffd43f94b6 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_header-and-footer.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx new file mode 100644 index 0000000000..afe07f6e93 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_header-and-footer.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png new file mode 100644 index 0000000000..b99cef3da0 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx new file mode 100644 index 0000000000..4fe9e65cb2 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/images/overview_manage-server_cluster-view.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/overview.markdown b/Documentation/7.0/Raven.Documentation.Pages/studio/overview.markdown new file mode 100644 index 0000000000..e060a419f2 --- /dev/null +++ b/Documentation/7.0/Raven.Documentation.Pages/studio/overview.markdown @@ -0,0 +1,174 @@ +# Studio Overview +--- + +{NOTE: } + +* RavenDB's **Management Studio** is installed along with the server and can + be accessed via any modern browser. + Access Studio using the server's URL, including its port number. E.g.: `http://localhost:8080` + +* Use Studio to manage your RavenDB + [cluster](../studio/cluster/cluster-dashboard/cluster-dashboard-overview), + [servers](../studio/server/manage-server), + and [databases](../studio/database/databases-list-view). + You can observe, modify, and create [indexes](../studio/database/indexes/indexes-overview), + issue [queries](../studio/database/queries/query-view), + adjust [settings](../studio/database/settings/database-settings), + view [statistics](../studio/database/stats/ongoing-tasks-stats/overview) + and [logs](../studio/server/debug/admin-logs), + define [ongoing tasks](../studio/database/tasks/ongoing-tasks/general-info), + [import](../studio/database/tasks/import-data/import-data-file) + and [export](../studio/database/tasks/export-database) data, + and much more. + +* In this page: + * [Accessing Studio After Setup](../studio/overview#accessing-studio-after-setup) + * [Connecting to an Unsecure server](../studio/overview#connecting-to-an-unsecure-server) + * [Connecting to a Secure server](../studio/overview#connecting-to-a-secure-server) + * [Where should the certificate be located](../studio/overview#where-should-the-certificate-be-located) + * [The Cluster Dashboard](../studio/overview#the-cluster-dashboard) + * [Manage Your Server](../studio/overview#manage-your-server) + * [Manage Your Databases](../studio/overview#manage-your-databases) + * [Header and Footer Areas](../studio/overview#header-and-footer-areas) +{NOTE/} + +--- + +{PANEL: Accessing Studio After Setup} + +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. + +{INFO: Secure and Unsecure servers} +When a RavenDB server runs for the first time, it presents its user with +a [setup wizard](../start/installation/setup-wizard#select-setup-mode). +You can use this wizard to select whether to install a **Secure** server +(with a [Let's Encrypt](../start/installation/setup-wizard#secure-setup-with-a-free-let) +or a [self-obtained](../start/installation/setup-wizard#secure-setup-with-your-own-certificate) +certificate) or an [Unsecure](../start/installation/setup-wizard#unsecure-setup) server. +{INFO/} + +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](../start/installation/setup-wizard#unsecure-setup) +server, **no certificate** is required and Studio can be directly connected using +the server's URL. +{WARNING: } +Please be aware that using an unsecure server is **not** recommended except for +experiments in a development environment. +{WARNING/} + +## Connecting to a Secure server: + +To connect to a **secure server**, the browser is required to own a **client certificate** +with [admin privileges](../server/security/authentication/client-certificate-usage). +Trying to connect to a secure server without a certificate +[will fail](../server/security/common-errors-and-faq#authentication-error-occurred-using-edge). + +#### Where should the certificate be located? + +Certificates must be installed where the browser can find them. + +* If you generate a [Let's Encrypt](../start/installation/setup-wizard#secure-setup-with-a-free-let) + 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](https://blog.chromium.org/2022/09/announcing-launch-of-chrome-root-program.html). + +* If you obtain the certificate [elsewhere](../start/installation/setup-wizard#secure-setup-with-your-own-certificate), + you need to ensure that it is properly registered where your browser can find it. + {NOTE: } + To register a certificate for Firefox or Chrome, you may need to + [explicitly import the certificate](../server/security/common-errors-and-faq#authentication-error-occurred-using-chrome) + into the browser's root store. + {NOTE/} + +{PANEL/} + +--- + +{PANEL: The Cluster Dashboard} + +* Open the **Cluster Dashboard** from Studio's main menu. +* A [Let's get started](../studio/cluster/cluster-dashboard/cluster-dashboard-widgets#let) + 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](../studio/cluster/cluster-dashboard/cluster-dashboard-customize), + 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. + +{INFO: } +[Learn more about the cluster dashboard](../studio/cluster/cluster-dashboard/cluster-dashboard-overview) +{INFO/} + +![Cluster Dashboard](images/overview_cluster-dashboard.png "Cluster Dashboard") + +{PANEL/} + +{PANEL: Manage your Server} + +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](images/overview_click-to-manage-server.png "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. + +{INFO: } +[Learn more about the Cluster view](../studio/cluster/cluster-view) +{INFO/} + +![Manage Server menu: Cluster view](images/overview_manage-server_cluster-view.png "Manage Server menu: Cluster view") + +{PANEL/} + +{PANEL: Manage your Databases} + +Access the **Databases View** from Studio's main menu. +![Click to manage databases](images/overview_click-to-manage-databases.png "Click to manage databases") + +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](images/overview_databases-view.png "Databases view") + +{PANEL/} + +{PANEL: Header and Footer Areas} + +![Header and Footer areas](images/overview_header-and-footer.png "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**. **Notification center** + See and dismiss notifications. +2. **Footer area** + * **A**. **Help and resources** + Click to consult with the community, to contact support, or for documentation. + * **B**. **Number of Documents in the selected database** + * **C**. **Number of Indexes** + * **D**. **Number of Stale indexes** + * **E**. **Database Authentication status** + * **F**. **Local Node tag** + Click to observe and configure another cluster node. + * **G**. **Studio version** + * **H**. **Server version** + * **I**. **License information** + * **J**. **Support information** + * **K**. [RavenDB Community](https://ravendb.net/community) + +{PANEL/} diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/server/.docs.json b/Documentation/7.0/Raven.Documentation.Pages/studio/server/.docs.json index 29c1047444..14d26fef6d 100644 --- a/Documentation/7.0/Raven.Documentation.Pages/studio/server/.docs.json +++ b/Documentation/7.0/Raven.Documentation.Pages/studio/server/.docs.json @@ -1,7 +1,7 @@ [ { - "Path": "server-dashboard.markdown", - "Name": "Server Dashboard", + "Path": "manage-server.markdown", + "Name": "Manage Server", "DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34", "Mappings": [] },