Skip to content

Commit

Permalink
Merge pull request #1731 from reebhub/RDoc-2550_serverLevelConfig
Browse files Browse the repository at this point in the history
Document the server settings view
  • Loading branch information
ppekrol authored Jan 5, 2024
2 parents a2efba3 + 84f9645 commit 9a52e83
Show file tree
Hide file tree
Showing 20 changed files with 126 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
"DiscussionId": "4af8df66-b4b6-4125-b6f4-b338e3d2d331",
"Mappings": []
},
{
"Path": "server-settings.markdown",
"Name": "Server Settings (Read Only)",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
},
{
"Path": "/debug",
"Name": "Debug",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Server Settings
---

{NOTE: }

* The **Server Settings** view displays settings common to all the databases
hosted by the server.
* This is a **read-only** view, showing settings made using
[environment variables](../../server/configuration/configuration-options#environment-variables),
the [settings.json](../../server/configuration/configuration-options#settings.json)
configuration file, and [command line arguments](../../server/configuration/configuration-options#command-line-arguments).
* For the server settings view open **Manage Server** `>>` **Server Settings**
* To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings) view.

* In this page:
* [Server Settings View](../../studio/server/server-settings#server-settings-view)

{NOTE/}

---

{PANEL: Server Settings View}

![Manage Server Section](images/server-settings_manage-server-section.png "Manage Server Section")

* **Manage Server**
Click to open the Manage Server section.

---

![Server Settings View](images/server-settings_server-settings-view.png "Server Settings View")

* **Server Settings**
Click to open the server settings view.

---

![Hover For Explanation Caption](images/server-settings_hover-for-explanation-caption.png "Hover For Explanation Caption")

* **Settings**
Hover any setting for a description of its functionality.

---

![List By Text](images/server-settings_list-by-text.png "List By Text")

* **Settings Selection Box**
Enter a string to display only the settings whose names contain this string.

{PANEL/}

## Related articles

**Studio**
[Server Dashboard](../../studio/server/server-dashboard)
[Cluster Dashboard](../../studio/cluster/cluster-dashboard/cluster-dashboard-overview)
[Database Settings](../../studio/database/settings/database-settings)
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
"DiscussionId": "4af8df66-b4b6-4125-b6f4-b338e3d2d331",
"Mappings": []
},
{
"Path": "server-settings.markdown",
"Name": "Server Settings (Read Only)",
"DiscussionId": "45fb3691-9d09-4957-bce9-1dbef89b5a34",
"Mappings": []
},
{
"Path": "/debug",
"Name": "Debug",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Server Settings
---

{NOTE: }

* The **Server Settings** view displays settings common to all the databases
hosted by the server.
* This is a **read-only** view, showing settings made using
[environment variables](../../server/configuration/configuration-options#environment-variables),
the [settings.json](../../server/configuration/configuration-options#settings.json)
configuration file, and [command line arguments](../../server/configuration/configuration-options#command-line-arguments).
* For the server settings view open **Manage Server** `>>` **Server Settings**
* To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings) view.

* In this page:
* [Server Settings View](../../studio/server/server-settings#server-settings-view)

{NOTE/}

---

{PANEL: Server Settings View}

![Manage Server Section](images/server-settings_manage-server-section.png "Manage Server Section")

* **Manage Server**
Click to open the Manage Server section.

---

![Server Settings View](images/server-settings_server-settings-view.png "Server Settings View")

* **Server Settings**
Click to open the server settings view.

---

![Hover For Explanation Caption](images/server-settings_hover-for-explanation-caption.png "Hover For Explanation Caption")

* **Settings**
Hover any setting for a description of its functionality.

---

![List By Text](images/server-settings_list-by-text.png "List By Text")

* **Settings Selection Box**
Enter a string to display only the settings whose names contain this string.

{PANEL/}

## Related articles

**Studio**
[Server Dashboard](../../studio/server/server-dashboard)
[Cluster Dashboard](../../studio/cluster/cluster-dashboard/cluster-dashboard-overview)
[Database Settings](../../studio/database/settings/database-settings)

0 comments on commit 9a52e83

Please sign in to comment.