# Settings

> Field reference for the dashboard's Settings page, covering the System, User, Users, Admin, Networking, Security, and Limits tabs.

The appliance’s Settings page holds appliance-wide preferences and administrative actions, distinct from per-surface configuration. Tab visibility is gated by two independent permissions, not a single role check: System, Admin, Networking, and Security require the settings-management permission; Users requires the separate user-management permission; User and Limits are visible to every signed-in user. Both default to administrator, so in an unmodified deployment the two gates show the same tabs to the same people, but an organisation that reassigns the user-management permission to a different role would see the Users tab without the rest.

## System tab (administrator)

This tab holds appliance-wide windows and retention periods behind the dashboard’s own live metrics (connection counts, latency, throughput), trading off how far back the dashboard can look against how much memory it spends holding that history. The defaults suit most appliances; adjust once you know your own traffic pattern.

- Shorten Metrics Retention Period, Total Connections Window, or Average Latency Window on a busier appliance to bound memory use and keep figures current. Shortening Average Latency Window specifically right after a change you’re watching closely keeps it reflecting only recent behavior.

- Raise Temporary Channel Timeout only if your onboarding flow routinely needs longer than 30 seconds to complete.

| Field | Default | Description |
| Metrics Retention Period (minutes) | 6 hours | How long to keep connection and rule-validation metrics. Range: 1 minute–7 days. |
| Task Activity Scope (seconds) | 60 seconds | Time window for calculating task throughput; recent activity resets the window. Range: 10–600 seconds. |
| Temporary Channel Timeout (seconds) | 30 seconds | How long a temporary onboarding channel stays active before automatic deletion. Range: 10–300 seconds. |
| Total Connections Window (minutes) | 60 minutes | Sliding window for the total-connections count. Range: 1 minute–24 hours. |
| Average Latency Window (minutes) | 60 minutes | Sliding window for average-latency calculations. Range: 1 minute–24 hours. |

## User tab

Personal preferences. These override the system defaults for your own dashboard session only.

| Field | Default | Description |
| Badge Time Threshold (minutes) | 5 minutes | Identities created or used within this time show a “new” or “active” badge. Range: 1 minute–24 hours. |
| Auto-Refresh Interval (seconds) | 5 seconds | Minimum time between dashboard data refreshes. Range: 1–300 seconds. |
| Log Timestamp Format | Local Time | Dropdown for log entry timestamps on the Logs page: Local Time, UTC (ISO 8601), Relative, or Compact. |
| Time Series Bucket Interval | 30 seconds | Default bucket interval (choose from 30 seconds up to 6 hours) for the aggregated connections time-series graph; can be overridden on the graph itself. |
| Minimum Payment Items to Display | 10 | Minimum number of payment items shown on the Payments page. |

## Users tab (administrator)

Dashboard account management for every user’s account, distinct from the singular User tab above, which holds only your own personal preferences. Administrator-only.

| Action | Description |
| Filter by role | Show only Administrator, Power User, or User accounts, or all of them. |
| Filter by status | Show only New, Approved, or Disabled accounts, or all of them. |
| Quick-approve | Approves a pending (New) account in place, without opening it for edit. |
| Edit | Opens an account for editing. |
| Delete | Removes an account. Not available for administrator accounts. |

## Admin tab (administrator)

Metrics/log housekeeping, plus the appliance’s data-portability actions: Backup, Restore, and Export Storage, covered in full in [Backup and encryption →](/products/affinidi-trust-fabric/agent-stream/reference/configuration/backup-and-encryption.md).

- Backup (under “Full Storage Backup”) gives you a restorable copy of the appliance’s configuration and data: run it before a risky change, or on a schedule as a disaster-recovery snapshot. It excludes logs and system_metrics, since those are ephemeral and regenerate at runtime.

- Restore (under “Restore from Backup”) rolls an appliance back to a previous backup, onto the same appliance it came from. Validation runs synchronously on upload, before anything is touched; a cross-domain, malformed, or otherwise invalid backup is rejected immediately with no storage mutation and no restart.

- Export Storage is the one to use when sharing data outside the appliance, such as with support, since secrets and PII are stripped or redacted.

| Action | Description |
| Truncate Old Metrics Now | Removes metrics older than the retention period immediately, without waiting for a restart. |
| Truncate Old Logs | Removes old and rotated log files. The current active log file is always kept. |
| Backup | Downloads an encrypted backup of the appliance’s storage as a single file, excluding logs and system_metrics. |
| Restore | Uploads a backup file to restore. The upload is validated immediately (domain, integrity, format); once accepted, the current storage is archived automatically first, and the appliance restarts to complete the restore. Restoring replaces the existing logs and system_metrics directories with whatever the backup contains (or removes them, if the backup predates their existence). |
| Export Storage | Downloads a PII-redacted snapshot of storage, encrypted to an Ed25519 public key you supply. Sensitive directories (keys, secrets, credentials, avatars) are excluded entirely. |

## Networking tab (administrator, read-only)

Shows the appliance’s inbound mTLS / client-certificate configuration. These values are set during provisioning and cannot be changed from the dashboard.

| Field | Description |
| Direct TLS client-cert request | Whether the appliance’s own TLS handshake asks for a client certificate: Disabled, Optional, or Required. |
| Trusted proxy CIDRs | Peer IPs allowed to present a forwarded client certificate header. Empty means the forwarded-cert path is disabled. |
| Forwarded client-cert header | The header name and wire format read when the peer matches a trusted proxy CIDR. The row is always shown; when no trusted proxy is configured, it displays an explanatory message instead of a header name. |

## Security tab (administrator)

Turn this on when you need a durable, queryable record of every allow/deny policy decision, whether for a compliance review or to investigate a specific denial after the fact. Structured logs and metrics are always emitted regardless of this switch, so leaving it off costs you only the durable audit-log entry, not observability itself.

| Field | Default | Description |
| Record policy decisions to the audit log | Off | Toggle. Records a durable, redacted entry for every allow/deny policy decision (pipe, IDE, gateway, and surface), viewable on the Audit page. |

## Limits tab

Read-only. Lists every configured appliance resource limit alongside its current usage. Reaching a limit prevents creating more of that entity until you upgrade your appliance tier.

## Related

- [Backup and encryption](/products/affinidi-trust-fabric/agent-stream/reference/configuration/backup-and-encryption.md): The backup and restore file format behind the Admin tab’s actions.

- [RBAC](/products/affinidi-trust-fabric/agent-stream/reference/security/rbac.md): Which role can see the administrator-only tabs.

- [Limit dashboard actions with RBAC roles](/products/affinidi-trust-fabric/agent-stream/how-to-guides/security/limit-dashboard-actions-with-rbac-roles.md): Assign the role that decides which accounts appear, and what they can do, on the Users tab.

- [Cost and usage governance](/products/affinidi-trust-fabric/agent-stream/concepts/cost-and-usage-governance.md): How appliance tier limits fit alongside spend-based budgets.
