TraxrGRC

Administrator's Guide

October 2026 · build 244823a

Installing, configuring, securing and operating a TraxrGRC instance.

About this guide

This guide is for the people who install and run TraxrGRC: the administrator who configures users, roles, sign-in and settings in the application, and the operator who runs the server, its backups and its upgrades. In a small team these are often the same person.

Who this guide is for

People who use the modules day to day should read the User Manual. New users should start with the Quick Start Guide.

How this guide is organized

ChapterWhat it covers
Architecture and RequirementsThe components of an instance, how they connect, and what the server needs
InstallationInstalling from a release, HTTPS options, the first administrator and the go-live checklist
Configuration ReferenceEvery environment variable and where each setting lives
Users, Groups and RolesAccounts, groups, roles and permissions, own and all scope, separation of duties
Authentication and Single Sign-OnPasswords, throttling, LDAP, SAML, SCIM provisioning and sessions
Platform SettingsEvery Settings page: branding, labels, custom fields and the module settings
Notifications and EmailSMTP, templates, rules, the scheduler, scheduled reports and the delivery log
Loading and Importing DataCSV imports, framework packages, the bundle loader, first-time migration and demo data
API Access and IntegrationsAPI tokens, the REST API, AI assistants (MCP) and service accounts
Audit Log and Evidence IntegrityWhat is logged, the Audit Log page and the tamper-evident hash chain
Backup and RestoreServer backups, in-app snapshots and a restore drill
UpgradesApplying a new release, what the update checks, and rolling back
Monitoring and TroubleshootingHealth checks, logs, chain verification and fixes for common failures
Security HardeningWhat the platform enforces and the operator's checklist

A first installation follows the chapters in order through Platform Settings. After go-live, the last four chapters are the routine.

Conventions

ConventionMeaning
BoldA label you see on screen: a menu entry, page title, tab, button, field or status, written exactly as it appears.
Settings → IntegrationsA navigation path: open Settings in the sidebar, then Integrations.
monospaceText you type or read literally: addresses, file names, commands, environment variables, permission names and API values.
module:rightA permission, for example settings:update (Update on the Settings module).
own and allThe two levels at which a role can hold a right; see Users, Groups and Roles.
Command blocksCommands to run on the server, from the instance directory (the one holding docker-compose.yml) unless the text says otherwise.

Settings pages. Every Settings page has a card on the Settings page, and each card is shown only to people the page itself admits. The sidebar's Settings entry appears for anyone who can open at least one of them. Each chapter also gives the page's address.

Screenshots show a demonstration installation with fictional data for an invented company, Quillmont Systems. Your product name, logo and data will differ.

Contents

  1. 1Architecture and Requirements
    1. 1.1Components
    2. 1.2How the components connect
    3. 1.3Host requirements
    4. 1.4Supported browsers
    5. 1.5Network ports
  2. 2Installation
    1. 2.1Before you begin
    2. 2.2Unpack the release
    3. 2.3Create the .env file
    4. 2.4Choose how HTTPS is provided
    5. 2.5First start
    6. 2.6Bootstrapping the first administrator
    7. 2.7First sign-in
    8. 2.8Post-installation checklist
    9. 2.9Running several instances on one server
  3. 3Configuration Reference
    1. 3.1How values reach the containers
    2. 3.2Instance settings (.env)
    3. 3.3Set by Compose and the image
    4. 3.4Operator script variables
    5. 3.5Development and demonstration only
    6. 3.6Settings that live in the application
  4. 4Users, Groups and Roles
    1. 4.1Where identity is administered
    2. 4.2User accounts
    3. 4.3Groups
    4. 4.4Roles
    5. 4.5Separation of duties
    6. 4.6Staff and portal-only users
    7. 4.7Effect of changes on open sessions
    8. 4.8Permission reference
  5. 5Authentication and Single Sign-On
    1. 5.1Sign-in methods at a glance
    2. 5.2Local passwords
    3. 5.3Sign-in throttling and lockout
    4. 5.4Two-step verification
    5. 5.5LDAP
    6. 5.6SAML single sign-on
    7. 5.7Account linking
    8. 5.8SSO only and break-glass administrators
    9. 5.9SCIM provisioning
    10. 5.10Sessions and sign-out
  6. 6Platform Settings
    1. 6.1How settings are stored and applied
    2. 6.2Map of the settings pages
    3. 6.3Branding
    4. 6.4Labels
    5. 6.5Custom fields
    6. 6.6Risk Settings
    7. 6.7Control testing settings
    8. 6.8Incident classifications
    9. 6.9Policy settings
    10. 6.10Privacy settings
    11. 6.11Sessions page: token lifetime, storage and separation of duties
    12. 6.12Settings checklist for a new instance
  7. 7Notifications and Email
    1. 7.1How email is sent
    2. 7.2Configuring SMTP
    3. 7.3Testing email
    4. 7.4The Notifications page
    5. 7.5Templates
    6. 7.6Scheduler
    7. 7.7Notification rules
    8. 7.8Scheduled reports delivery
    9. 7.9The delivery log
    10. 7.10Deliverability
  8. 8Loading and Importing Data
    1. 8.1Choosing a method
    2. 8.2What a new installation already contains
    3. 8.3CSV imports
    4. 8.4Compliance framework packages
    5. 8.5The bundle loader
    6. 8.6First-time migration
    7. 8.7Demo data
  9. 9API Access and Integrations
    1. 9.1Integration points
    2. 9.2API tokens
    3. 9.3The REST API for administrators
    4. 9.4AI assistants (MCP)
    5. 9.5Service accounts and token practice
  10. 10Audit Log and Evidence Integrity
    1. 10.1What is logged
    2. 10.2The Audit Log page
    3. 10.3The hash chain
    4. 10.4Retention
    5. 10.5Security alerts
    6. 10.6Evidence file fingerprints
    7. 10.7Files moved onto evidence
    8. 10.8Using the audit log as evidence
  11. 11Backup and Restore
    1. 11.1Server backups
    2. 11.2Restoring a server backup
    3. 11.3In-app snapshots
    4. 11.4Restore drill
  12. 12Upgrades
    1. 12.1Before you upgrade
    2. 12.2Running an update
    3. 12.3What the update does
    4. 12.4When an update fails
    5. 12.5Rolling back
    6. 12.6Cleaning up after upgrades
    7. 12.7Upgrading an installation from before October 2026
  13. 13Monitoring and Troubleshooting
    1. 13.1Health checks
    2. 13.2Logs
    3. 13.3Row counts
    4. 13.4Common problems
  14. 14Security Hardening
    1. 14.1What the product enforces
    2. 14.2Operator checklist
    3. 14.3Known limits
  15. Index