Skip to content

Document full Settings tab layout in UI install guide #940

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

Open
danbarr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document full Settings tab layout in UI install guide #940

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 22 additions & 18 deletions docs/toolhive/guides-ui/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,28 +102,32 @@ icon for quick access. The tray menu includes:
## Application settings

Open the ToolHive settings screen from the gear icon (⚙️) in the application
window. The settings screen allows you to configure various options:

- **Display theme**: Choose between light and dark themes for the application.
ToolHive matches your system theme by default.
- **Start on login**: Automatically start ToolHive when you log in to your
system. MCP servers that were running when you quit ToolHive are restarted
automatically.
- **Error reporting**: Enable or disable error reporting and telemetry data
collection.
- **Skip quit confirmation**: Skip the MCP server shutdown confirmation dialog
when quitting ToolHive.

The settings screen also includes a **Version** tab and a **Logs** tab:

- **Version** tab: Displays the Desktop UI version and ToolHive binary version.
A green **Latest** badge appears next to each component when you are running
the current version. The **Downloads** toggle controls whether ToolHive
window. The settings screen is organized into tabs:
Comment thread
danbarr marked this conversation as resolved.

- **General**: Application-wide preferences, including:
- **Display theme**: Choose between light and dark themes for the application.
ToolHive matches your system theme by default.
- **Start on login**: Automatically start ToolHive when you log in to your
system. MCP servers that were running when you quit ToolHive are restarted
automatically.
- **Error reporting**: Enable or disable error reporting and telemetry data
collection.
- **Skip quit confirmation**: Skip the MCP server shutdown confirmation dialog
when quitting ToolHive.
- **Registry**: Choose the registry that ToolHive uses to discover MCP servers.
See [Use the registry](./registry.mdx).
- **Secrets**: Add and manage the secrets that your MCP servers use. See
[Secrets management](./secrets-management.mdx).
- **CLI**: Install the `thv` command-line tool and check its status. See
[Access the CLI](./cli-access.mdx).
- **Version**: Displays the Desktop UI version and ToolHive binary version. A
green **Latest** badge appears next to each component when you are running the
current version. The **Downloads** toggle controls whether ToolHive
automatically downloads and installs updates when a new release is available
(enabled by default). If you disable auto-updates, an alert appears when a new
version is available with a **Download** button so you can update manually. A
blue indicator icon on the **Version** tab signals that an update is ready.
- **Logs** tab: Download the application log file for troubleshooting.
- **Logs**: Download the application log file for troubleshooting.

## Upgrade ToolHive

Expand Down