Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cx: desktop settings reporting #21646

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
description: Understand how to use the Desktop settings reporting dashboard
keywords: Settings Management, docker desktop, hardened desktop, reporting, compliance
title: Desktop settings reporting
linkTitle: Desktop Settings Reporting
weight: 30
---

Desktop settings reporting is a feature of Desktop Settings Management that tracks and reports user compliance with the settings that are assigned to them. This lets you track the application of settings and monitor what actions they need to take to make users compliant.

This guide provides steps for accessing the reporting dashboard, viewing compliance status, and resolving non-compliant users.
Copy link

@pla-sam pla-sam Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Is "dashboard" the right word?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aevesdocker @ajthilakan curious for your thoughts

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually reserve 'dashboard' when referring to the whole of the product as opposed to a page within a product - Docker Desktop Dashboard or Scout Dashboard etc. So yeh I'd rephrase this sentence some how.


## Access Desktop settings reporting

1. Sign in to the [Admin Console](https://app.docker.com/admin).
2. Select your organization or company from the **Choose profile** page.
3. Under Docker Desktop, select **Reporting**.

This opens the Desktop settings reporting dashboard. From here you can:

- Use the **Search** field to search by username or email address
- Filter by policies
- Hide or un-hide compliant users
- View a user’s compliance status and what policy is assigned to the user
- Download a CSV file of user compliance information

## View compliance status

1. Sign in to the [Admin Console](https://app.docker.com/admin).
2. Select your organization or company from the **Choose profile** page.
3. Under Docker Desktop, select **Reporting**.
4. By default, non-compliant users are displayed.
5. Optional. Select the **Hide compliant users** checkbox to show both compliant and non-compliant users.
6. Use the **Search** field to search by username or email address.
7. Hover over a user’s compliance status indicator to quickly view their status.
8. Select a username to view more details about their compliance status, and for steps to resolve non-compliant users.

## Resolve compliance status

To resolve compliance status, you must view a user's compliance status details by selecting their username from the Desktop settings reporting page. These details include the following information:

- **Compliance status**: Indicates whether the user is compliant with the settings applied to them
- **Domain status**: Indicates whether the user’s email address is associated with a verified domain
- **Settings status**: Indicates whether the user has settings applied to them
- **Resolution steps**: If a user is non-compliant, this provides information on how to resolve the user’s compliance status

### Compliant

When a user is compliant, a **Compliant** icon appears next to their name on the Desktop settings reporting dashboard. Select a compliant user to open their compliance status details. Compliant users have the following status details:

- **Compliance status**: Compliant
- **Domain status**: Verified domain
- **Settings status**: Compliant
- **User is compliant** indicator

No resolution steps are needed for compliant users.

### Non-compliant

When a user is non-compliant, a **Non-compliant** or **Unknown** icon appears next to their name on the Desktop settings reporting dashboard. Non-compliant users must have their compliance status resolved:

1. Select a username from the Desktop settings reporting dashboard.
2. On the compliance status details page, follow the resolution steps provided to resolve the compliance status.
3. Refresh the page to ensure the resolution steps resolved the compliance status.