Skip to content

Commit e1d5b13

Browse files
mintlify[bot]mintlify[bot]
authored
device agent quick guide (#1627)
* Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 4820f04 commit e1d5b13

File tree

3 files changed

+183
-194
lines changed

3 files changed

+183
-194
lines changed

‎packages/docs/device-agent.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+
21+
22+
**Memory:** 512MB RAM minimum
23+
24+
**Storage:** 200MB available disk space
25+
26+
<Note>
27+
For OS not currently support by the Comp AI device agent, manual evidence will be required of the device's settings.
28+
</Note>
29+
30+
### Installation Guide
31+
32+
On your org's [portal](http://portal.trycomp.ai), click the "Download and Install Comp AI Device Agent" dropdown
33+
34+
### Mac OS additional action
35+
36+
For Mac OS, users must enable MDM to complete the installation process:
37+
38+
<Accordion title="MDM User Guide" description="Enable MDM" icon="computer">
39+
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:
40+
41+
![My Device Pn](/packages/docs/images/my-device.png)
42+
43+
You should see a banner that asks you to enable MDM. Click the button:
44+
45+
![Enable Mdm Pn](/packages/docs/images/enable-mdm.png)
46+
47+
Click the Download button:
48+
49+
![Click Download Button Pn](/packages/docs/images/click-download-button.png)
50+
51+
Return to your Downloads folder and click on _fleet-mdm-enrollment-profile.mobileconfig:_
52+
53+
![Downloads Folder Pn](/packages/docs/images/downloads-folder.png)
54+
55+
The following warning will appear, click OK:
56+
57+
<img
58+
src="/packages/docs/images/click-ok.png"
59+
alt="Click Ok Pn"
60+
title="Click Ok Pn"
61+
style={{ width:"55%" }}
62+
/>
63+
64+
Click the Apple icon in the upper left corner and go to System Settings:
65+
66+
![System Settings Icon Pn](/packages/docs/images/system-settings-icon.png)
67+
68+
In System Settings, locate and click ‘Profile Downloaded’ in the left-hand column. Double-click on the Comp AI enrollment on the right:
69+
70+
<img
71+
src="/packages/docs/images/device-management.png"
72+
alt="Device Management Pn"
73+
title="Device Management Pn"
74+
style={{ width:"99%" }}
75+
/>
76+
77+
Click Install…:
78+
79+
<img
80+
src="/packages/docs/images/install-comp-ai.png"
81+
alt="Install Comp Ai Pn"
82+
title="Install Comp Ai Pn"
83+
style={{ width:"56%" }}
84+
/>
85+
86+
Click Install:
87+
88+
<img
89+
src="/packages/docs/images/final-install.png"
90+
alt="Final Install Pn"
91+
title="Final Install Pn"
92+
style={{ width:"56%" }}
93+
/>
94+
95+
Enter Credentials and click Enrol:
96+
97+
<img
98+
src="/packages/docs/images/enrol.png"
99+
alt="Enrol Pn"
100+
title="Enrol Pn"
101+
style={{ width:"38%" }}
102+
/>
103+
104+
Enrollment is then complete:
105+
106+
<img
107+
src="/packages/docs/images/enrollment-complete.png"
108+
alt="Enrollment Complete Pn"
109+
title="Enrollment Complete Pn"
110+
style={{ width:"60%" }}
111+
/>
112+
</Accordion>
113+
114+
<Accordion title="Windows Manual Evidence" description="Evidence to gather manually for unsupported windows devices" icon="sparkles">
115+
### **Windows 10 & 11**
116+
117+
1. **Enable BitLocker**
118+
1. Press **Start** → type **Manage BitLocker** → open it.\
119+
👉 **Take a screenshot of the BitLocker Drive Encryption window showing “On” for the C: drive.**
120+
2. Select the drive (usually C:) → click **Turn on BitLocker**.
121+
3. Save the recovery key to Microsoft Account / USB / secure location.
122+
4. Restart if prompted.
123+
2. **Screen Lock after 5 Minutes**
124+
1. Press **Start** → **Settings** → **Personalization** → **Lock screen**.
125+
2. Scroll down → click **Screen timeout settings**.\
126+
👉 **Take a screenshot showing the screen timeout set to 5 minutes.**
127+
3. Set **Screen turns off** = 5 minutes.
128+
4. In **Settings** → **Accounts** → **Sign-in options** → ensure **Require sign-in** is set to _“When PC wakes up from sleep”_.\
129+
👉 **Take a screenshot of the Sign-in Options page showing this setting**
130+
3. **Minimum Password Length (Local Policy)**
131+
1. Press Win + R, type secpol.msc, press Enter.
132+
2. Go to **Account Policies** → **Password Policy**.
133+
3. Set **Minimum password length** = 8+.\
134+
👉 **Take a screenshot of the Password Policy window with “Minimum password length” = 8 or more.**\
135+
_(If using Microsoft/AD/Azure, enforce via policy centrally and screenshot the policy compliance in the admin portal.)_
136+
4. **Automatic Security Updates**
137+
1. **Settings** → **Update & Security** → **Windows Update**.
138+
2. Select **Advanced options** → make sure Automatic updates are enabled.\
139+
👉 **Take a screenshot of the Windows Update settings page showing automatic updates turned on.**
140+
5. **Antivirus (Windows Defender)**
141+
1. **Settings** → **Update & Security** → **Windows Security**.
142+
2. Open **Virus & threat protection** → ensure **Real-time protection** is on.\
143+
👉 **Take a screenshot of the Windows Security window showing Real-time protection is ON.**
144+
145+
<Note>
146+
Evidence gathered manually will be uploaded as a comment + attachment to the "Secure Devices" & "Device List" tasks with the users email of the device the evidence is for.
147+
</Note>
148+
</Accordion>
149+
150+
<Accordion title="Mac Manual Evidence" description="Evidence to gather manually for unsupported mac devices" icon="sparkles">
151+
### **macOS (Monterey, Ventura, Sonoma)**
152+
153+
1. **Enable FileVault**
154+
1. Open **System Settings** (or **System Preferences** in older versions).
155+
2. Go to **Privacy & Security** → **FileVault**.
156+
3. Click **Turn On FileVault** → enter password.
157+
4. Record recovery key.\
158+
👉 **Take a screenshot of the FileVault settings page showing “FileVault is enabled for the disk.”**
159+
2. **Screen Auto-lock (5 min)**
160+
1. **System Settings** → **Lock Screen**.
161+
2. Set **Start screen saver when inactive** = 5 minutes.\
162+
👉 **Take a screenshot showing the setting at 5 minutes.**
163+
3. Set **Require password after sleep or screen saver begins** = _Immediately_.\
164+
👉 **Take a screenshot showing “Require password immediately” is selected.**
165+
3. **Minimum Password Length (Mac Lock Screen PW)**
166+
1. Native macOS UI doesn’t enforce; requires **Terminal** or **MDM**.
167+
2. `pwpolicy -setglobalpolicy "minChars=8"`
168+
3. 👉 **If set via Terminal, take a screenshot of the command output confirming the policy.**
169+
4. If enforced by MDM (Jamf, Intune, etc.), **screenshot the compliance screen from the MDM portal.**
170+
4. **Automatic Security Updates**
171+
1. **System Settings** → **General** → **Software Update**.
172+
2. Click **Automatic Updates** → enable all options (Install Security Responses & System files, etc.).\
173+
👉 **Take a screenshot of the Automatic Updates options screen with all toggles enabled.**
174+
5. **Antivirus (XProtect built-in)**
175+
1. macOS automatically runs **XProtect** in the background.
176+
2. Simply ensure macOS is **fully updated**.\
177+
👉 **Take a screenshot of the Software Update page showing the Mac is up to date.**
178+
179+
<Note>
180+
Evidence gathered manually will be uploaded as a comment + attachment to the "Secure Devices" & "Device List" tasks with the users email of the device the evidence is for.
181+
</Note>
182+
</Accordion>

‎packages/docs/device-agnet.mdx‎

Lines changed: 0 additions & 182 deletions
This file was deleted.

‎packages/docs/docs.json‎

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,7 @@
1515
"groups": [
1616
{
1717
"group": "Get Started",
18-
"pages": ["introduction", "quickstart", "development"]
19-
},
20-
{
21-
"group": "Essentials",
22-
"pages": [
23-
"essentials/markdown",
24-
"essentials/code",
25-
"essentials/images",
26-
"essentials/settings",
27-
"essentials/navigation",
28-
"essentials/reusable-snippets"
29-
]
18+
"pages": ["introduction", "quickstart", "development", "device-agent"]
3019
}
3120
]
3221
},

0 commit comments

Comments
 (0)