Skip to content

Commit f0ef397

Browse files
authored
Add new setting screen, other minor polish (#71)
1 parent a5e2e78 commit f0ef397

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

docs/toolhive/guides-ui/install.mdx

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Select your operating system to see the installation instructions.
3838
Download the latest ToolHive installer for
3939
[Apple silicon](https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive-arm64.dmg)
4040
or
41-
[Intel-based](https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive-arm64.dmg)
41+
[Intel-based](https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive-x64.dmg)
4242
Macs and open the DMG file.
4343

4444
Copy the ToolHive app to your Applications folder. You can then open it from
@@ -53,8 +53,8 @@ and run the setup executable.
5353

5454
:::note
5555

56-
The Windows installer is not digitally signed yet, so you will need to accept
57-
the warning from Windows Defender SmartScreen. We're working on getting a signed
56+
The Windows installer is not digitally signed yet, so you'll need to accept the
57+
warning from Windows Defender SmartScreen. We're working on getting a signed
5858
installer published soon.
5959

6060
:::
@@ -96,22 +96,31 @@ and extract it, then run the `ToolHive` binary directly.
9696

9797
## System tray icon
9898

99-
When you close the ToolHive application window, it stays running in the
99+
When you close the ToolHive application window, it continues running in the
100100
background so your MCP servers remain available. ToolHive installs a system tray
101101
icon for quick access. You can use it to:
102102

103103
- Enable or disable **Start on login**
104104
- Show or hide the ToolHive application window
105105
- Quit ToolHive, which stops all running MCP servers
106106

107-
## Run ToolHive on login
107+
## Application settings
108108

109-
You can configure ToolHive to start automatically when you log in to your
110-
system. This is useful if you want your MCP servers to be available without
111-
manually starting ToolHive each time.
109+
Open the ToolHive settings screen from the gear icon (⚙️) in the application
110+
window. The settings screen allows you to configure various options:
112111

113-
To enable this feature, turn on the **Start on login** option in the system tray
114-
icon menu or in the settings menu (⚙️) in the application.
112+
- **Display theme**: Choose between light and dark themes for the application.
113+
ToolHive matches your system theme by default.
114+
- **Start on login**: Automatically start ToolHive when you log in to your
115+
system. MCP servers that were running when you quit ToolHive are restarted
116+
automatically.
117+
- **Error reporting**: Enable or disable error reporting and telemetry data
118+
collection.
119+
- **Skip quit confirmation**: Skip the MCP server shutdown confirmation dialog
120+
when quitting ToolHive.
121+
122+
From the settings screen, you can also view version information and download the
123+
application log file for troubleshooting.
115124

116125
## Upgrade ToolHive
117126

@@ -178,13 +187,16 @@ configuration file and secrets store to support coexistence.
178187
</TabItem>
179188
</Tabs>
180189

190+
You can also download the application log file from the **Settings** screen (⚙️)
191+
in the ToolHive UI.
192+
181193
## Telemetry and error reporting
182194

183195
ToolHive uses [Sentry](https://sentry.io/welcome/) for error tracking and
184196
performance monitoring to help us identify and fix issues, improve stability,
185197
and enhance the user experience. This telemetry is enabled by default. You can
186-
disable this by turning off the **Error reporting** option in the settings menu
187-
(⚙️) if you prefer not to share this data.
198+
disable this by turning off the **Error reporting** option in the settings
199+
screen (⚙️) if you prefer not to share this data.
188200

189201
ToolHive collects the following information:
190202

@@ -215,15 +227,15 @@ MCP servers. See [Run MCP servers](./run-mcp-servers.md) to get started.
215227
<details>
216228
<summary>Connection Refused error on startup</summary>
217229

218-
If you see a "Connection Refused" error when starting ToolHive, it's likely
219-
because your container runtime (Docker or Podman) is not installed, not running,
220-
or not configured correctly.
230+
If you see a "Connection Refused" error when starting ToolHive, your container
231+
runtime (Docker or Podman) is likely not installed, not running, or not
232+
configured correctly.
221233

222-
Follow the instructions on the error message to install or start your container
223-
runtime. For example, if you're using Docker Desktop, make sure it is running
224-
and that the Docker daemon is active.
234+
Follow the instructions in the error message to install or start your container
235+
runtime. For example, if you're using Docker Desktop, make sure it's running and
236+
that the Docker daemon is active.
225237

226-
If the retry button doesn't work, try restarting ToolHive.
238+
If the retry button doesn't work, restart ToolHive.
227239

228240
</details>
229241

0 commit comments

Comments
 (0)