Skip to content

Commit c79efc9

Browse files
authored
Add troubleshooting step for ensuring permissions (#31)
1 parent e296872 commit c79efc9

File tree

4 files changed

+64
-17
lines changed

4 files changed

+64
-17
lines changed

pages/oneleet-agent/troubleshooting.mdx

Lines changed: 64 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,54 @@ If you still can't confirm if the Oneleet Agent is running or not, try the final
4444
</Tabs.Tab>
4545
</Tabs>
4646

47-
If you've confirmed that the Oneleet Agent isn't running after following the steps above, skip to the [Restart your device](#restart-your-device) step below.
47+
### Make sure the Oneleet Agent has the permissions it needs (macOS only)
48+
49+
On macOS, the Oneleet Agent needs certain permissions enabled in order to run properly. To check if it has the permissions it needs, follow the steps below:
50+
51+
1. Open **System Settings****Privacy & Security****Automation**
52+
2. Click on **Oneleet** to expand it and see which permissions are enabled
53+
3. Make sure the **System Settings** and **System Events** permissions are both enabled
54+
55+
![macOS permissions](/oneleet-agent/macos-permissions.png)
56+
57+
If you made any changes to enable the permissions, you'll need to quit and restart the Oneleet Agent to apply them.
58+
59+
### Quit and restart the Oneleet Agent
60+
61+
Quitting and restarting the Oneleet Agent can sometimes resolve temporary issues or conflicts. To quit the Oneleet Agent, open the Oneleet Agent menu and click on **Quit**. If you're unsure how to start the Oneleet agent again, see the [Setup Guide](/oneleet-agent/setup).
62+
63+
<Tabs items={["macOS", "Windows"]}>
64+
<Tabs.Tab>![macOS restart](/oneleet-agent/macos-quit.png)</Tabs.Tab>
65+
<Tabs.Tab>![Windows restart](/oneleet-agent/windows-quit.png)</Tabs.Tab>
66+
</Tabs>
67+
68+
If you can't find the Oneleet Agent menu, see the [Once the Oneleet Agent is running, where can I find it?](/oneleet-agent/faq#once-the-oneleet-agent-is-running-where-can-i-find-it) section of our FAQ. If you still can't find the Oneleet Agent menu after this, try finding and quitting the Oneleet Agent process directly:
69+
70+
<Tabs items={["macOS", "Windows", "Linux"]}>
71+
<Tabs.Tab>
72+
1. Open **Activity Monitor** and search for "Oneleet"
73+
2. Click on the Oneleet Agent process in the list and click the **X** button towards the top of the window
74+
3. Click on the **Quit** button in the dialog that appears.
75+
4. If that doesn't work, follow step 2 again and click the **Force Quit** button instead.
76+
77+
![macOS quit](/oneleet-agent/macos-quit-activity-monitor.png)
78+
79+
</Tabs.Tab>
80+
<Tabs.Tab>
81+
1. Open **Task Manager** and search for "Oneleet" in the **Processes** tab
82+
2. Right-click on the Oneleet Agent process in the list and click **End Task**
83+
84+
![Windows quit](/oneleet-agent/windows-quit-task-manager.png)
85+
86+
</Tabs.Tab>
87+
<Tabs.Tab>
88+
1. In your terminal, run `ps aux | grep oneleet`
89+
2. Find the Oneleet Agent process in the output and note its PID (process ID) in the second column
90+
3. Kill the process by running: `kill <PID>` (replace `<PID>` with the process ID)
91+
4. If that doesn't work, force kill it with: `kill -9 <PID>`
92+
93+
</Tabs.Tab>
94+
</Tabs>
4895

4996
### Log out and log in again
5097

@@ -77,22 +124,13 @@ To check if your version of the Oneleet Agent is up to date, open the Oneleet Ag
77124
</Tabs.Tab>
78125
</Tabs>
79126

80-
### Quit and restart the Oneleet Agent
81-
82-
Quiting and restarting the Oneleet Agent can sometimes resolve temporary issues or conflicts. To quit the Oneleet Agent, open the Oneleet Agent menu and click on **Quit**. If you're unsure how to start the Oneleet agent again, see the [Setup Guide](/oneleet-agent/setup).
83-
84-
<Tabs items={["macOS", "Windows"]}>
85-
<Tabs.Tab>![macOS restart](/oneleet-agent/macos-quit.png)</Tabs.Tab>
86-
<Tabs.Tab>![Windows restart](/oneleet-agent/windows-quit.png)</Tabs.Tab>
87-
</Tabs>
88-
89127
### Restart your device
90128

91129
Restarting your device can also resolve temporary issues or conflicts.
92130

93131
### Reinstall the Oneleet Agent
94132

95-
First, follow the uninstallation steps in the [Setup Guide](/oneleet-agent/setup). Once uninstalled, and follow the download and installation steps to download and install a fresh copy of the Oneleet Agent.
133+
First, follow the uninstallation steps in the [Setup Guide](/oneleet-agent/setup). Once uninstalled, follow the download and installation steps to download and install a fresh copy of the Oneleet Agent.
96134

97135
### Ensure your operating system is up to date
98136

@@ -102,7 +140,7 @@ An out-of-date operating system could lead to issues with the Oneleet Agent. Ens
102140

103141
As a last resort, try deleting all app data and configuration for the Oneleet Agent.
104142

105-
First make sure to first quit the Oneleet Agent. Then, delete the app data folder for the Oneleet Agent. The location of this folder depends on your operating system:
143+
First make sure to quit the Oneleet Agent. Then, delete the app data folder for the Oneleet Agent. The location of this folder depends on your operating system:
106144

107145
<Tabs items={['macOS', 'Windows', 'Linux']}>
108146
<Tabs.Tab>
@@ -179,14 +217,17 @@ To ensure the Oneleet Agent starts automatically when you restart your computer,
179217
<Tabs.Tab>
180218
1. Open the Oneleet Agent menu in your menu bar (top right of your screen)
181219
- If you don't see the Oneleet icon in your menu bar, see the [I can't see the Oneleet icon in my menu bar](#i-cant-see-the-oneleet-icon-in-my-menu-bar) section below
182-
2. Hover over **Settings** in the dropdown
183-
menu that appears
220+
2. Hover over **Settings** in the dropdown menu that appears
184221
3. Ensure the **Launch Oneleet at login** setting is checked off in the submenu that appears
185222

186223
![macOS launch Oneleet at login](/oneleet-agent/macos-launch-at-login.png)
187224

188225
</Tabs.Tab>
189226
<Tabs.Tab>
227+
<Callout type="warning">
228+
There's a known ongoing issue where the Oneleet Agent does not start automatically on Windows even when **Launch Oneleet at login** is enabled. Until we're able to release a fix for this, the Oneleet Agent will need to be manually started after each reboot.
229+
</Callout>
230+
190231
1. Open the Oneleet Agent menu in your system tray (bottom right of your screen)
191232
2. Hover over **Settings** in the dropdown menu that appears
192233
3. Ensure the **Launch Oneleet at login** setting is checked off in the submenu that appears
@@ -210,11 +251,17 @@ If the above still doesn't resolve the issue, please follow the [delete all Onel
210251

211252
### I can't see the Oneleet icon in my menu bar
212253

213-
If you can't see the Oneleet icon in your Mac's menu bar, either the Oneleet Agent is not running, or it may simply be hidden because there are too many apps displaying in your menu bar and not enough space to display an icon for the Oneleet Agent.
254+
If you can't see the Oneleet icon in your Mac's menu bar, this could either be because the Oneleet Agent is not running, the Oneleet Agent is missing required permissions to run properly, or because there are simply too many apps displaying in your menu bar and not enough space to display an icon for the Oneleet Agent.
255+
256+
1. First, check to make sure the Oneleet Agent is actually running by following the [Check if the Oneleet Agent is running](#check-if-the-oneleet-agent-is-running) step in the general troubleshooting section above.
257+
258+
2. If you've confirmed that the Oneleet Agent is running but still can't see the Oneleet icon in your menu bar, follow the [Make sure the Oneleet Agent has the permissions it needs (macOS only)](#make-sure-the-oneleet-agent-has-the-permissions-it-needs-macos-only) step in the general troubleshooting section above to make sure the Oneleet Agent has the permissions it needs to run properly.
259+
260+
3. If you've confirmed that the Oneleet Agent is running and has the required permissions but still can't see the Oneleet icon in your menu bar, try freeing up space in your menu bar by temporarily quitting some menu bar apps (right-click and quit). If quitting an app reveals a new icon on the left side of the menu bar that you didn't see before, the Oneleet icon is likely hidden due to lack of space.
214261

215-
First, check to make sure the Oneleet Agent is actually running by following the [Check if the Oneleet Agent is running](#check-if-the-oneleet-agent-is-running) step in the general troubleshooting section above.
262+
### Autofix isn't working
216263

217-
If you've confirmed that it's running but still can't see the Oneleet icon in your menu bar, try freeing up some space in your menu bar to make room for the Oneleet icon by temporarily right-clicking and quitting some of the apps in your menu bar. A general rule of thumb is that if you quit one of the apps in your menu bar and a new app icon appears on the lefthand side of the menu bar that you didn't see before, the Oneleet icon is likely being hidden because of a lack of space in the menu bar.
264+
If autofix isn't working, see the [Make sure the Oneleet Agent has the permissions it needs (macOS only)](#make-sure-the-oneleet-agent-has-the-permissions-it-needs-macos-only) step in the general troubleshooting section above to make sure the Oneleet Agent has the permissions it needs to update the settings on your device.
218265

219266
## Windows
220267

423 KB
Loading
329 KB
Loading
194 KB
Loading

0 commit comments

Comments
 (0)