Skip to content

Commit 70dd0c2

Browse files
committed
docs: add administration and configuration guide
1 parent 8d25623 commit 70dd0c2

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ rather than installing a second one.
138138
After the wizard finishes, open the app and finish **Setup** in the browser to
139139
supply the Graph credentials used for collection.
140140

141+
For detailed instructions on user roles (RBAC), setting up SMTP notifications, and general configuration, see the [Administration & Configuration Guide](docs/ADMINISTRATION.md).
142+
141143

142144

143145
---

docs/ADMINISTRATION.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Administration & Configuration
2+
3+
Vigil365 provides built-in tools for managing who has access to the dashboard and configuring how the system behaves. All administrative actions are recorded in a tamper-evident audit log.
4+
5+
## User Management & RBAC
6+
7+
Access to Vigil365 is controlled via in-app Role-Based Access Control (RBAC). When the application is first installed via the setup wizard, the user who runs the setup is automatically granted the **Admin** role.
8+
9+
From the **Administration > User Management** page, Admins can invite other users from your Microsoft 365 tenant.
10+
11+
### Available Roles
12+
13+
| Role | Permissions |
14+
|------|-------------|
15+
| **Admin** | Full access. Can invite/remove users, change application configuration, configure notification channels, and modify alert policies. |
16+
| **Analyst** | Triage access. Can acknowledge, resolve, and snooze alerts. Can view all reports, dashboards, and investigations, but cannot change system configuration or invite users. |
17+
| **Viewer** | Read-only access. Can view all dashboards, alerts, and reports, but cannot modify alert states or configurations. |
18+
19+
### Tamper-Evident Audit Trail
20+
To ensure accountability, every privileged action taken within Vigil365 (e.g., inviting a user, changing a role, modifying a policy) is permanently recorded in the **Audit Log**. This log is SHA-256 hash-chained, meaning that any attempt to manually tamper with or delete records in the underlying SQL database will be detected and flagged by the application.
21+
22+
---
23+
24+
## Initial Setup & Configuration
25+
26+
When you launch Vigil365 for the first time, you will be guided through a setup checklist to ensure the dashboard can successfully collect data from your tenant.
27+
28+
### 1. Microsoft Graph Connection
29+
Vigil365 requires a connection to your Microsoft 365 tenant to aggregate security alerts.
30+
If you used the Interactive Setup Wizard, this Entra ID App Registration was created automatically.
31+
If the dashboard reports missing permissions, navigate to **Administration > Setup** to view exactly which Graph API permissions are missing and grant Admin Consent in the Azure Portal.
32+
33+
### 2. Notification Channels (SMTP & Webhooks)
34+
To receive alerts outside of the dashboard, you must configure your notification channels:
35+
- **Email (SMTP):** Configure your SMTP server details to enable Daily/Weekly Executive Digest reports and email alerts.
36+
- **Teams / Slack / Generic Webhooks:** You can route specific alert policies to external chat channels or SIEMs.
37+
38+
All secrets (like SMTP passwords and webhook URLs) are encrypted at rest using the Windows Data Protection API (DPAPI) and are never exposed in plaintext to the frontend.
39+
40+
### 3. Alert Policies
41+
By default, Vigil365 imports a set of best-practice alert policies. You can customize these thresholds or create entirely new anomaly/activity-based policies in the **Alert Center > Policies** tab.
42+
43+
*Tip: Before enabling a new policy, use the "Dry Run" feature to backtest it against your historical data to see how many times it would have fired in the past 30 days.*

0 commit comments

Comments
 (0)