Getting Started

Installing from Atlassian Marketplace#

1. Go to marketplace.atlassian.com and search for “Aegis Compliance Suite”.
2. Click Get it now (or Try it free for a trial).
3. Select your Confluence Cloud site from the dropdown.
4. Click Install and accept the required permissions.
5. Once installation is complete, navigate to your Confluence Cloud site.
6. Open any Confluence page, you will see the Aegis exposure score byline beneath the page title.
7. Access the main dashboard via the Confluence top navigation: Apps → Aegis Compliance Suite.

Note: The user who installs the app is automatically assigned the Admin role.

First-Time Setup Checklist#

Follow these steps in order to configure Aegis properly for your organization. Steps 1–3 are essential for basic operation; step 4 sets up alert rules.

Step 1: Assign Roles to Your Team#

By default, all users except the initial Admin are assigned the Viewer role and cannot create or edit anything. You must assign Analyst, Approver, or Admin roles before team members can take action.

1. Open Confluence Settings → Aegis Compliance Suite Settings.
2. Click the Permissions tab.
3. In the search box, type at least 2 characters of a team member’s display name.
4. Select the user from the results dropdown.
5. Choose the appropriate role from the Role dropdown (Viewer, Analyst, Approver, or Admin).
6. Click Save.
7. Repeat for each team member.

Step 2: Configure Content Detectors#

Aegis ships with 200+ pre-built regex detectors sourced from the gitleaks ruleset. Only 4 are enabled by default (AWS Access Key, Credit Card, SSN, Private Key). Before running your first scan, review which detectors match your organization’s risk profile.

1. Open Confluence Settings → Aegis Compliance Suite Settings.
2. Click the Detectors tab.
3. Browse the accordion groups by category (Cloud Platforms, Source Control & CI/CD, Communication, AI & ML, and more).
4. Toggle individual detectors on or off by clicking the toggle next to each one.
5. Optionally, scroll to the bottom of the Detectors tab to add a Custom Detector: provide a name, regex pattern, severity, and category.
6. Click Save after any changes.

Note: Generic patterns like generic-api-key, generic-secret, and password-in-text are intentionally off by default to reduce false-positive noise. Enable them only if your environment uses consistent naming conventions that these patterns can match reliably.

Step 3: Run Your First Content Scan#

1. Navigate to the main dashboard: Apps → Aegis Compliance Suite.
2. Click the Scanning tab.
3. In the toolbar at the top, select Full scan from the scan type dropdown.
4. Click Start Scan.
5. Watch the progress strip, it shows Spaces Completed, Pages Scanned, and Findings Created in real time.
6. When the scan completes, the status bar shows “Scan complete” with a checkmark.
7. Click the Findings tab to review all findings detected by the scanner.

Warning: Scans are always manually triggered. There is no scheduled automatic content scan, this is an intentional design decision to give your team full control over when scanning occurs. The hourly permission scan (for exposure scoring) runs automatically; only the content scan requires manual initiation.

Step 4: Set Up Alert Rules#

Alert rules notify your team when important events occur.

1. Navigate to Apps → Aegis Compliance Suite.
2. Click the Alerts tab.
3. Click Add Rule.
4. Select a trigger type (e.g., “New Critical Finding”, “SLA Breach”, “Score Increase”).
5. Set any threshold, scope, and debounce window settings for the rule.
6. Click Save Rule.

You should create at minimum:

• A rule for critical_finding (fires when any critical finding is created).
• A rule for sla_breach (fires when a case’s deadline is breached).

Accessing the App#

The dashboard opens to the tab you were last viewing (your tab position is saved in browser session storage and restored across page refreshes within the same browser session).

Role Permission Matrix#

Aegis uses a four-tier hierarchical role model. Higher roles inherit all permissions of lower roles.

Note: Role checks are enforced server-side on every resolver call. It is not possible to bypass role restrictions by modifying the frontend.

Role Assignment Walkthrough#

Scenario: You want to give Alice the Analyst role and Bob the Approver role.

1. Open Confluence Settings (gear icon in the top navigation).
2. Under “Apps & Integrations”, click Aegis Compliance Suite Settings.
3. The settings page opens to the Permissions tab by default.
4. In the “Search for a user” field, type “Alice” (at least 2 characters).
5. A dropdown appears with matching Confluence users. Select Alice’s account.
6. In the “Role” dropdown that appears to the right, select Analyst.
7. Click Save. A confirmation message appears briefly.
8. Repeat steps 4–7 for Bob, selecting Approver.

Note: If you cannot see the Permissions tab, you do not have the Admin role. Contact whoever first opened the app after installation, they are the initial Admin.