mirror of
https://github.com/fleetdm/fleet
synced 2026-05-24 09:28:54 +00:00
573bf877fe
@ddribeiro After talking with Noah about troubleshooting and logs, I thought it would be good if we created a user-facing guide for troubleshooting. Our CSEs frequently send the same troubleshooting information to customers when they report issues. We can empower customers with one resource that they can work through, reducing the significant amount of time in back-and-forth steps sent over Slack. Also, we've talked about pulling the "Finding fleetd logs" section out of the [Enroll hosts](https://fleetdm.com/guides/enroll-hosts) guide. Perhaps when this is complete, we can link to this document from that guide. This certainly doesn't contain everything! Please bring the CSEs in to flesh this out since they're in the day-to-day and have much more knowledge regarding this than I do. --------- Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| all | ||
| android/configuration-profiles | ||
| api-scripts | ||
| docker-compose | ||
| ios-ipados | ||
| linux | ||
| macos | ||
| tines | ||
| windows | ||
| README.md | ||
Solutions
Best Practices
General
- Name the file what the profile does.
- For example, instead of
googlePlayProtectVerifyApps.json(the name of the Android policy for this control), describe what it does:enforce-google-play-protect.json.
- For example, instead of
- Use kebab case in file names, with all letters in lowercase.
- Instead of
passwordPolicy.json, usepassword-policy.json.
- Instead of
- Be sure to end files with an empty newline.
symlinks
If a solution is applicable to multiple platforms, keep the original in the main platform directory and symlink it to the other platforms. For example, if an Apple configuration profile can be used on both macOS and iOS, use macOS as the source, and create a symlink in the iOS directory.
cd docs/solutions/ios-ipados/configuration-profiles/- Note that this is the destination that we want the symlink to be in.
ln -s ../../macos/configuration-profiles/my-profile.mobileconfig .- The
.here at the end means the current directory, and will use the same file name as the original (which is what we want).
- The
git add profile.mobileconfiggit commit