Graham McIntie
397271ce03
- nix.md: TimescaleDB now enabled for both dev and test databases - nix.md: added troubleshooting section for TimescaleDB reinitialization - New: docs/features/organization-settings.md (tabbed interface, all tabs documented) - New: docs/features/device-monitoring.md (schema field reference, activity feed fields, SNMP socket management)
81 lines
2.5 KiB
Markdown
81 lines
2.5 KiB
Markdown
# Organization Settings
|
|
|
|
Organization settings are managed through a tabbed interface at `/orgs/:slug/settings`.
|
|
|
|
## Tabs
|
|
|
|
### General
|
|
|
|
- **Organization name** — 2-100 characters
|
|
- **Default organization** — set which org loads on login (visible when user has multiple orgs)
|
|
- **Site organization** — toggle `use_sites` to group devices into physical locations
|
|
|
|
### SNMP
|
|
|
|
Default SNMP configuration applied to all devices (overridable at site or device level).
|
|
|
|
- **Version**: v1, v2c, or v3
|
|
- **Community string** (v1/v2c)
|
|
- **SNMPv3 credentials** (v3): username, auth protocol/password, privacy protocol/password
|
|
- **Port**: default 161
|
|
- **Force apply**: push org-level SNMP config to all existing devices
|
|
|
|
Configuration hierarchy: **Device > Site > Organization**
|
|
|
|
### MikroTik (superuser only)
|
|
|
|
RouterOS API credentials for MikroTik device management.
|
|
|
|
- Enable/disable MikroTik API
|
|
- Username, password, port (default 8729)
|
|
- SSL toggle with security warnings for plain API
|
|
|
|
### Agents
|
|
|
|
Default polling agent assignment.
|
|
|
|
- Select default remote agent or use cloud polling
|
|
- View device assignment breakdown (device-level, site-level, org-level, cloud)
|
|
- Force apply default agent to all devices
|
|
|
|
### Integrations
|
|
|
|
Third-party service connections. Each integration has:
|
|
|
|
- **API key** (encrypted at rest via Cloak)
|
|
- **Sync interval** (minutes)
|
|
- **Enable/disable toggle**
|
|
- **Test connection** button
|
|
- **Sync status** and schedule display
|
|
|
|
#### Preseem
|
|
|
|
QoE monitoring for wireless ISPs. Links to:
|
|
- Device management (`/settings/integrations/preseem/devices`)
|
|
- Network Insights (`/insights?source=preseem`)
|
|
|
|
#### Gaiia
|
|
|
|
Billing and subscriber management. Includes:
|
|
- Entity mapping (`/settings/integrations/gaiia/mapping`)
|
|
- Reconciliation (`/settings/integrations/gaiia/reconciliation`)
|
|
- **Webhook configuration**: URL and secret for real-time updates from Gaiia
|
|
|
|
## URL Structure
|
|
|
|
```
|
|
/orgs/:slug/settings → General tab (default)
|
|
/orgs/:slug/settings?tab=snmp → SNMP tab
|
|
/orgs/:slug/settings?tab=mikrotik → MikroTik tab
|
|
/orgs/:slug/settings?tab=agents → Agents tab
|
|
/orgs/:slug/settings?tab=integrations → Integrations tab
|
|
```
|
|
|
|
Invalid `?tab=` values default gracefully to the General tab.
|
|
|
|
## Technical Notes
|
|
|
|
- The General/SNMP/MikroTik/Agents tabs share a single organization changeset form
|
|
- The Integrations tab uses separate per-provider forms
|
|
- Integration credentials are stored encrypted using `Encrypted.Map` (Cloak + AES-GCM)
|
|
- All settings changes are audit-logged
|