Skip to content

Commit c2cf379

Browse files
authored
Merge pull request #1305 from trycompai/dustin/device-agent-user-guide
Comp AI Device Agent User Guide
2 parents 3739e93 + e3a990a commit c2cf379

29 files changed

Lines changed: 182 additions & 0 deletions

packages/docs/device-agent-zip.png

157 KB
Loading

packages/docs/device-agnet.mdx

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
---
2+
title: "Comp AI Device Agent"
3+
description: "Device Agent & MDM User Setup Guide"
4+
---
5+
6+
#### **About Comp AI device agent**
7+
8+
Installing Comp AI Device Agent helps you and your security administrator keep your device protected against security threats.
9+
10+
Comp AI Device Monitor is a lightweight agent that helps ensure your device meets security compliance requirements.
11+
12+
It monitors device configuration, installed software, and security settings to help maintain a secure work environment.
13+
14+
**Security powered by Comp AI:** Your organization uses Comp AI to maintain security and compliance standards.
15+
16+
If you have questions, contact your IT administrator.
17+
18+
### System Requirements
19+
20+
**Operating Systems:** macOS 10.14\+, Windows 10\+, Ubuntu 18.04\+
21+
22+
**Memory:** 512MB RAM minimum
23+
24+
**Storage:** 200MB available disk space
25+
26+
### Installation Guide
27+
28+
On your org's [portal](http://portal.trycomp.ai), click the "Download and Install Comp AI Device Agent" dropdown
29+
30+
Full installation and erollment is a 3 step process outlined below:
31+
32+
<Accordion title="Step 1" description='Run "run_me_first.command"' icon="sparkles">
33+
Go to your Downloads file and click into the newly downloaded .zip file
34+
35+
![Device Agent Zip Pn](/packages/docs/device-agent-zip.png)
36+
37+
Then click into the newly created folder
38+
39+
![Newly Created Folder Pn](/packages/docs/newly-created-folder.png)
40+
41+
Double-click the “run_me_first.comand” and then click Done to the ‘Not Opened’ warning
42+
43+
![Run Me First Pn](/packages/docs/run-me-first.png)
44+
45+
Click the Apple icon in the upper left corner and go to System Settings
46+
47+
![System Settings Pn](/packages/docs/system-settings.png)
48+
49+
Go to Privacy and Security and within the Security section scroll down to “run_me_first.command was blocked” and click the Open Anyway button
50+
51+
![Always Open Pn](/packages/docs/images/always-open.png)
52+
53+
Click Open Anyway on the warning
54+
55+
![Open Anyway Pn](/packages/docs/images/open-anyway.png)
56+
57+
Click Use Password… in the box that appears and enter your credentials in the next box
58+
59+
![Use Password Pn](/packages/docs/images/use-password.png)
60+
61+
Once entering your credentials the file should run (you can then close this window)
62+
63+
![Close Window Pn](/packages/docs/images/close-window.png)
64+
</Accordion>
65+
66+
<Accordion title="Step 2" description="Install Device Agent" icon="download">
67+
Back in the Downloaded folder click“compai-device-agent.pkg”
68+
69+
![Agent Pkg Pn](/packages/docs/images/agent-pkg.png)
70+
71+
Click Done to the warning:
72+
73+
![Warning Pn](/packages/docs/images/warning.png)
74+
75+
Click the Apple icon in the upper left corner and go to System Settings:
76+
77+
![System Settings Icon Pn](/packages/docs/images/system-settings-icon.png)
78+
79+
Go to Privacy and Security and within the Security section scroll down to “run_me_first.command was blocked” and click the Open Anyway button:
80+
81+
![Security Run Me First Pn](/packages/docs/images/security-run-me-first.png)
82+
83+
Click Open Anyway on the warning:
84+
85+
![Open Anyway Pkg Pn](/packages/docs/images/open-anyway-pkg.png)
86+
87+
Click Use Password and enter credentials:
88+
89+
![Use Password Pkg Pn](/packages/docs/images/use-password-pkg.png)
90+
91+
The Installation window should open, click Continue:
92+
93+
![Fleet Install Pn](/packages/docs/images/fleet-install.png)
94+
95+
Click Install:
96+
97+
![Click Install Pn](/packages/docs/images/click-install.png)
98+
99+
Enter Password and click Install Software:
100+
101+
![Enter Password Pkg Pn](/packages/docs/images/enter-password-pkg.png)
102+
103+
Click Close:
104+
105+
![Install Complete Pkg Pn](/packages/docs/images/install-complete-pkg.png)
106+
</Accordion>
107+
108+
<Accordion title="Step 3" description="Enable MDM" icon="computer">
109+
At the top of your screen, find the Fleet Desktop app which looks like an F made of dots. Click on it and click My Device:
110+
111+
![My Device Pn](/packages/docs/images/my-device.png)
112+
113+
You should see a banner that asks you to enable MDM. Click the button:
114+
115+
![Enable Mdm Pn](/packages/docs/images/enable-mdm.png)
116+
117+
Click the Download button:
118+
119+
![Click Download Button Pn](/packages/docs/images/click-download-button.png)
120+
121+
Return to your Downloads folder and click on _fleet-mdm-enrollment-profile.mobileconfig:_
122+
123+
![Downloads Folder Pn](/packages/docs/images/downloads-folder.png)
124+
125+
The following warning will appear, click OK:
126+
127+
<img
128+
src="/packages/docs/images/click-ok.png"
129+
alt="Click Ok Pn"
130+
title="Click Ok Pn"
131+
style={{ width:"55%" }}
132+
/>
133+
134+
Click the Apple icon in the upper left corner and go to System Settings:
135+
136+
![System Settings Icon Pn](/packages/docs/images/system-settings-icon.png)
137+
138+
In System Settings, locate and click ‘Profile Downloaded’ in the left-hand column. Double-click on the Comp AI enrollment on the right:
139+
140+
<img
141+
src="/packages/docs/images/device-management.png"
142+
alt="Device Management Pn"
143+
title="Device Management Pn"
144+
style={{ width:"99%" }}
145+
/>
146+
147+
Click Install…:
148+
149+
<img
150+
src="/packages/docs/images/install-comp-ai.png"
151+
alt="Install Comp Ai Pn"
152+
title="Install Comp Ai Pn"
153+
style={{ width:"56%" }}
154+
/>
155+
156+
Click Install:
157+
158+
<img
159+
src="/packages/docs/images/final-install.png"
160+
alt="Final Install Pn"
161+
title="Final Install Pn"
162+
style={{ width:"56%" }}
163+
/>
164+
165+
Enter Credentials and click Enrol:
166+
167+
<img
168+
src="/packages/docs/images/enrol.png"
169+
alt="Enrol Pn"
170+
title="Enrol Pn"
171+
style={{ width:"38%" }}
172+
/>
173+
174+
Enrollment is then complete:
175+
176+
<img
177+
src="/packages/docs/images/enrollment-complete.png"
178+
alt="Enrollment Complete Pn"
179+
title="Enrollment Complete Pn"
180+
style={{ width:"60%" }}
181+
/>
182+
</Accordion>

packages/docs/images/agent-pkg.png

78.4 KB
Loading
461 KB
Loading
268 KB
Loading
131 KB
Loading

packages/docs/images/click-ok.png

79.7 KB
Loading
173 KB
Loading
162 KB
Loading
107 KB
Loading

0 commit comments

Comments
 (0)