# TrueNAS Connect Documentation

> This site provides comprehensive documentation for TrueNAS Connect, a cloud-based management platform that simplifies TrueNAS administration through a unified web interface. Connect eliminates the need to access individual systems directly by providing centralized monitoring, health reporting, hardware inventory, and remote installation capabilities.

## Quick Reference - Most Common Tasks

### Getting Started with TrueNAS Connect
1. **Initial Setup**: Access TrueNAS Connect through the TrueNAS system UI status icon
2. **Authentication**: Sign up using Google or GitHub account (no additional hardware required)
3. **System Registration**: Add TrueNAS systems to centralized management dashboard
4. **Keyring Setup**: Configure secure authentication for multiple systems

### Core Connect Features
- **Centralized Monitoring**: Monitor multiple TrueNAS systems from single dashboard
- **Health Reporting**: Automated alerts and system status monitoring
- **Hardware Inventory**: Complete system component tracking and reporting
- **Remote Installation**: Network-based TrueNAS installation and setup tools

## Site Structure and Navigation

### Main Documentation Sections
- **Essentials**: https://connect.truenas.com/essentials/ - Core functionality and setup guides
- **Tutorial**: https://connect.truenas.com/docs/tutorial/ - Step-by-step learning materials
- **How-To**: https://connect.truenas.com/docs/how-to/ - Task-specific operational guides
- **Reference**: https://connect.truenas.com/docs/reference/ - UI screen descriptions and technical details

### Key Essential Topics
- **Getting Started**: https://connect.truenas.com/essentials/getting-started/ - Initial setup and authentication
- **Health Reporting**: https://connect.truenas.com/essentials/health-reporting/ - System monitoring and alerts
- **TrueNAS Management**: https://connect.truenas.com/essentials/truenas-management/ - System configuration and control
- **Remote Install**: https://connect.truenas.com/essentials/remote-install/ - Network-based installation tools

## TrueNAS Connect Overview

### Platform Description
TrueNAS Connect is a cloud-based management platform that provides:
- **Unified Interface**: Single web interface for managing multiple TrueNAS systems
- **Remote Access**: Access from any device with internet connection
- **Simplified Administration**: No complex configuration or additional hardware required
- **Centralized Control**: Monitor, configure, and manage entire TrueNAS infrastructure

### Authentication and Access
- **Account Requirements**: Google or GitHub account (email authentication planned for future)
- **Setup Process**: Direct integration through TrueNAS system UI
- **Security**: Keyring-based authentication for secure multi-system access
- **Multi-System Support**: Single account can manage multiple TrueNAS installations

## Documentation Organization

### Tutorial Content (Learning-Focused)
- **Getting Started Tutorial**: https://connect.truenas.com/docs/tutorial/getting-started/ - Complete setup walkthrough
- **Health Reporting Tutorial**: https://connect.truenas.com/docs/tutorial/health-reporting/ - Monitoring setup and configuration
- **Inventory Tutorial**: https://connect.truenas.com/docs/tutorial/inventory/ - Hardware tracking and reporting
- **Keyring Management Tutorial**: https://connect.truenas.com/docs/tutorial/managing-the-keyring/ - Secure authentication setup
- **Remote Install Tutorial**: https://connect.truenas.com/docs/tutorial/remote-install/ - Network installation procedures

### How-To Guides (Task-Focused)
- **Add Notification Tasks**: https://connect.truenas.com/docs/how-to/add-notification-tasks/ - Configure automated alerts
- **Customize Account**: https://connect.truenas.com/docs/how-to/customize-your-account/ - Personalize Connect interface
- **Export Inventory Data**: https://connect.truenas.com/docs/how-to/export-inventory-data/ - Hardware data extraction

### Reference Documentation (Interface-Focused)
- **Dashboard Screen**: https://connect.truenas.com/docs/reference/dashboard-screen/ - Main interface overview
- **Inventory Screen**: https://connect.truenas.com/docs/reference/inventory-screen/ - Hardware tracking interface
- **Applications Screen**: https://connect.truenas.com/docs/reference/applications-screen/ - Application management interface
- **Keyring Screen**: https://connect.truenas.com/docs/reference/keyring-screen/ - Authentication management interface
- **Profile Screen**: https://connect.truenas.com/docs/reference/profile-screen/ - Account settings interface
- **Top Toolbar**: https://connect.truenas.com/docs/reference/top-toolbar-screen/ - Navigation and controls reference

## LLM Usage Guidelines

### Content Context
- **Cloud-based Platform**: TrueNAS Connect is a web-based service, not locally installed software
- **Management Focus**: Documentation centers on managing existing TrueNAS systems, not TrueNAS installation
- **Multi-System Environment**: Designed for users managing multiple TrueNAS installations
- **Remote Operations**: Emphasizes capabilities for users not physically present at TrueNAS systems

### Response Strategy
- **Setup Guidance**: Direct users to essentials section for initial setup and configuration
- **Feature Discovery**: Use tutorial sections to explain Connect capabilities and workflows
- **Task Completion**: Reference how-to guides for specific operational procedures
- **Interface Questions**: Use reference documentation for UI screen and field descriptions

### Version and Compatibility
- **Connect Version**: Currently version 0.7.1 as specified in site configuration
- **TrueNAS Compatibility**: Works with current TrueNAS SCALE and CORE versions
- **Cloud Service**: No local installation required, accessed via web browser
- **Authentication**: Currently supports Google and GitHub accounts

## Cross-References

### Main TrueNAS Documentation
- **TrueNAS SCALE**: https://truenas.com/docs/scale/ - Base system documentation for Connect-managed systems
- **TrueNAS CORE**: https://truenas.com/docs/core/ - Legacy system documentation
- **Hardware Documentation**: https://truenas.com/docs/hardware/ - Physical system specifications and setup

### Related TrueNAS Resources
- **Community Forums**: https://forums.truenas.com/ - Community support and discussions
- **TrueNAS Downloads**: https://truenas.com/download-truenas-community-edition/ - System software downloads
- **Support Portal**: https://support.ixsystems.com/ - Commercial support services (requires support contract)

### TrueNAS Documentation Ecosystem
- **Apps Documentation**: https://apps.truenas.com/ - Application deployment on TrueNAS systems
- **API Documentation**: https://api.truenas.com/ - TrueNAS API reference for integration
- **Security Advisories**: https://security.truenas.com/ - Security information for managed systems

## Support and Contact Information

### TrueNAS Connect Support
- **Documentation**: Primary resource for Connect-specific questions and procedures
- **Community Forums**: https://forums.truenas.com/ - Free community support
- **GitHub Repository**: https://github.com/truenas/connect-docs - Documentation contributions and issues

### Commercial Support
- **Support Contract Required**: TrueNAS Connect commercial support requires active support contract
- **Support Portal**: https://support.ixsystems.com/ - Ticketed support for contract holders
- **Email Support**: support@ixsystems.com - Direct support contact
- **Additional Resources**: https://ixsystems.com/support/ - Phone and resource information

## Usage Notes for LLMs

### Documentation Structure
- **Docsy Theme**: Site uses Google Docsy theme with custom TrueNAS styling
- **Include Files**: Content uses Hugo include files for shared content blocks
- **Screen Documentation**: Reference section uses specialized screen capture and description system
- **Version Targeting**: Content focuses on current Connect version (0.7.1)

### Content Approach
- **Task-Oriented**: Documentation organized around user goals and workflows
- **Progressive Learning**: Essentials → Tutorial → How-To → Reference progression
- **Visual Integration**: Heavy use of screenshots and UI guidance
- **Platform Integration**: Assumes familiarity with base TrueNAS system administration

### Platform Context
- **Cloud Dependency**: All Connect functionality requires internet access and cloud service availability
- **Authentication Dependency**: Full functionality requires Google or GitHub account
- **Commercial Features**: Some advanced features may require TrueNAS support contracts