Home Getting Started
📚

Getting Started

New to Airys? Start here to learn the basics, from installation to core features. Quick setup guides and essential information to get you running in minutes.
Gabriel
By Gabriel
• 5 articles

Welcome to Airys

Overview Welcome to Airys, your comprehensive solution for intelligent camera management and face analysis. This guide will help you understand what Airys can do for you and how to get started with its powerful features. Difficulty Level: Beginner Time Required: 10 minutes Last Updated: February 2024 Prerequisites - A modern web browser (Chrome, Firefox, Safari, or Edge) - Valid Airys account credentials - Internet connection - At least one compatible IP camera (optional for initial setup) Table of Contents 1. What is Airys? 2. Key Features 3. Getting Started Steps 4. Best Practices 5. FAQ 6. Related Articles What is Airys? Airys is a state-of-the-art web application that combines advanced camera management with powerful face analysis capabilities. Our platform helps you: - Monitor and manage multiple camera streams in real-time - Perform accurate face detection and recognition - Secure your environment with intelligent monitoring - Analyze facial features with DeepFace technology [Screenshot/Image Placeholder 1] Caption: Airys Dashboard Overview Key Features Camera Management - Multi-camera support with GO2RTC integration - Real-time stream monitoring - Customizable stream grid layout - Advanced stream overlay options Face Analysis - Real-time face detection - Accurate face recognition - Privacy-focused processing - DeepFace integration [Screenshot/Image Placeholder 2] Caption: Key Features Overview 💡 Pro Tip: Start with a single camera to familiarize yourself with the interface before adding more streams. Getting Started Steps 1. Create Your Account - Visit the Airys login page - Click "Sign Up" - Fill in your details - Verify your email 2. First Login [Screenshot/Image Placeholder 3] Caption: Login Screen - Enter your credentials - Complete initial setup wizard - Review security settings 3. Add Your First Camera - Navigate to "Camera Management" - Click "Add New Camera" - Enter camera details - Test the connection Best Practices - ✅ Regularly update your password - ✅ Start with basic features before exploring advanced options - ✅ Keep your camera firmware updated - ❌ Don't share your login credentials - ❌ Avoid using public networks for initial setup Frequently Asked Questions Q: Do I need special hardware to use Airys? A: No, Airys works with most modern IP cameras. However, for optimal face analysis performance, we recommend cameras with at least 1080p resolution. Q: Can I try Airys before purchasing? A: Yes! We offer a 30-day free trial with full access to all features. Q: Is my data secure? A: Absolutely. Airys uses end-to-end encryption and follows strict privacy guidelines. All face analysis is performed locally on your system. Related Articles - System Requirements - First-time Setup Guide - Understanding the Dashboard Need More Help? If you couldn't find what you were looking for in this article: - Check our Troubleshooting Guide - Join our Community Forum - Contact Support Tags: welcome, getting-started, overview, introduction

Last updated on Feb 12, 2025

System Requirements

Overview Before installing Airys, ensure your system meets these requirements for optimal performance and functionality. Difficulty Level: Beginner Time Required: 5 minutes Last Updated: February 2024 Prerequisites - Basic knowledge of your system specifications - Administrator access to your system - Internet connection for installation Table of Contents 1. Hardware Requirements 2. Software Requirements 3. Network Requirements 4. Camera Requirements 5. FAQ Hardware Requirements Minimum Specifications - CPU: Dual-core processor, 2.0 GHz or higher - RAM: 4GB minimum (8GB recommended) - Storage: 1GB free space for installation - Graphics: Basic GPU for web interface - Display: 1280x720 resolution or higher Recommended Specifications - CPU: Quad-core processor, 3.0 GHz or higher - RAM: 16GB for optimal performance - Storage: 5GB or more for recordings and data - Graphics: Dedicated GPU for multiple camera streams - Display: 1920x1080 resolution or higher 💡 Pro Tip: For systems running multiple camera streams with face analysis, we recommend using the recommended specifications. Software Requirements Operating System - Windows: Windows 10/11 (64-bit) - macOS: Big Sur (11.0) or later - Linux: Ubuntu 20.04 LTS or later Required Software - Modern web browser (Chrome, Firefox, Edge, Safari) - Node.js 16.x or later - Docker (for container deployment) - Python 3.8 or later (for face analysis) Network Requirements Minimum Requirements - Stable internet connection - Upload speed: 5 Mbps minimum - Download speed: 10 Mbps minimum - Open ports for camera streams - Static IP recommended for remote access Firewall Configuration - Allow WebSocket connections - Enable RTSP/RTMP protocols - Configure required ports: - Web interface: 3000 - API server: 3001 - GO2RTC: 8554 - DeepFace: 5000 Camera Requirements Compatible Camera Types - IP cameras with RTSP support - USB webcams - Network cameras supporting ONVIF - H.264/H.265 capable devices Camera Specifications - Minimum resolution: 720p - Recommended resolution: 1080p - Frame rate: 15-30 FPS - Network bandwidth: 2-4 Mbps per camera Frequently Asked Questions Q: Can I run Airys on a virtual machine? A: Yes, but performance may be limited, especially for face analysis features. We recommend running on bare metal for optimal performance. Q: Do I need a dedicated GPU? A: While not required for basic functionality, a dedicated GPU is recommended for systems running multiple cameras with face analysis. Q: How many cameras can I connect? A: The number of cameras depends on your hardware specifications and network bandwidth. With recommended specs, you can typically run 8-12 cameras efficiently. Related Articles - First-time Setup Guide - Camera Setup - Performance Optimization Need More Help? If you couldn't find what you were looking for in this article: - Check our Troubleshooting Guide - Join our Community Forum - Contact Support Tags: requirements, hardware, software, network, cameras, specifications

Last updated on Feb 12, 2025

First-time Setup Guide

Overview Get started with Airys by following this step-by-step installation and configuration guide. We'll walk you through the entire process from installation to your first camera setup. Difficulty Level: Beginner Time Required: 30 minutes Last Updated: February 2024 Prerequisites - System meeting minimum requirements - Administrator access to your system - Your camera details (if setting up cameras) - Internet connection Table of Contents 1. Installation 2. Initial Configuration 3. Account Setup 4. First Camera Setup 5. Verification Steps 6. FAQ Installation Step 1: Download Airys 1. Visit the Airys download page [Screenshot/Image Placeholder 1] Caption: Airys download page with version selection - Choose your operating system - Select the latest stable version - Download the installer package Step 2: Install Dependencies 1. Install Docker - Windows: Use Docker Desktop - Linux: Follow distribution-specific instructions - macOS: Use Docker Desktop for Mac 2. Install Node.js - Download from nodejs.org - Install version 16.x or later 💡 Pro Tip: Use the LTS (Long Term Support) versions of Node.js for best compatibility. Step 3: Run Installation 1. Run the Airys installer [Screenshot/Image Placeholder 2] Caption: Installation wizard main screen - Accept license agreement - Choose installation directory - Select components to install Initial Configuration Step 1: Environment Setup 1. Configure environment variables - Copy .env.example to .env - Set required variables: - PORT=3000 - API_URL=http://localhost:3001 - GO2RTC_URL=ws://localhost:8554 Step 2: Start Services 1. Launch required services docker-compose up -d - Verify all containers are running - Check service health status Account Setup Step 1: Create Admin Account 1. Access the web interface [Screenshot/Image Placeholder 3] Caption: Account creation form - Navigate to http://localhost:3000 - Click "Create Account" - Fill in admin details Step 2: Security Settings 1. Configure security options - Set up two-factor authentication (recommended) - Configure password requirements - Set session timeout preferences First Camera Setup Step 1: Add Camera 1. Navigate to Camera Management - Click "Add Camera" - Enter camera details: - Name - IP address/URL - Authentication details - Stream type (RTSP/RTMP) Step 2: Test Connection 1. Verify camera connection - Test stream connection - Adjust video quality settings - Configure stream overlay options Verification Steps 1. System Health Check - All services running - No error messages - Camera streams accessible - Face analysis working (if enabled) 2. Performance Verification - Check CPU usage - Monitor memory consumption - Verify network bandwidth Frequently Asked Questions Q: How long does installation typically take? A: The basic installation takes about 10-15 minutes. Full setup with camera configuration may take 30 minutes. Q: Can I change the ports used by Airys? A: Yes, you can modify the ports in the .env file, but make sure they don't conflict with other services. Q: What if my camera isn't automatically detected? A: You can manually add camera details or check our Camera Troubleshooting Guide. Related Articles - System Requirements - Understanding the Dashboard - Camera Setup Guide Need More Help? If you couldn't find what you were looking for in this article: - Check our Troubleshooting Guide - Join our Community Forum - Contact Support Tags: installation, setup, configuration, first-time, getting-started

Last updated on Feb 12, 2025

Understanding the Dashboard

Overview Learn about the Airys dashboard interface and its key components. This guide will help you navigate and understand all the essential features available at your fingertips. Difficulty Level: Beginner Time Required: 15 minutes Last Updated: February 2024 Prerequisites - Completed First-time Setup - Active Airys account - Successfully logged into the system Table of Contents 1. Dashboard Layout 2. Main Components 3. Navigation 4. Quick Actions 5. Customization 6. FAQ Dashboard Layout Main Sections [Screenshot/Image Placeholder 1] Caption: Annotated dashboard layout showing main sections 1. Top Navigation Bar - User profile menu - System notifications - Quick settings - Help center access 2. Sidebar Navigation - Camera management - Face analysis - Settings - Reports - System status 3. Main Content Area - Camera grid view - Analytics displays - Active notifications - System metrics 💡 Pro Tip: Use keyboard shortcuts (press '?' to view) for quick navigation between sections. Main Components Camera Grid [Screenshot/Image Placeholder 2] Caption: Camera grid with multiple active streams - Live camera feeds - Stream status indicators - Quick camera controls - Face detection overlays Analytics Panel - Real-time statistics - Face detection counts - System performance metrics - Event notifications Status Bar - System health indicators - Active services status - Network performance - Storage usage Navigation Using the Sidebar 1. Expanding/Collapsing - Click menu icon to toggle - Hover for quick view - Pin for permanent display 2. Section Access - Single click to navigate - Right-click for context menu - Drag to reorder favorites Quick Navigation - Search bar functionality - Recent items list - Favorite sections - Custom shortcuts Quick Actions Common Tasks [Screenshot/Image Placeholder 3] Caption: Quick actions menu with common tasks 1. Camera Controls - Add new camera - Start/Stop streams - Adjust layouts - Configure settings 2. Face Analysis - Enable/Disable detection - Adjust sensitivity - Export results - View history 3. System Actions - Generate reports - Check system health - Backup settings - Update software Customization Personal Preferences 1. Layout Options - Grid size adjustment - Theme selection - Font size - Language preference 2. Display Settings - Camera feed quality - Refresh rates - Notification preferences - Timeline display Frequently Asked Questions Q: Can I customize the dashboard layout? A: Yes, you can rearrange camera feeds, resize panels, and save custom layouts for different monitoring needs. Q: How do I access historical data? A: Use the timeline feature at the bottom of the dashboard or navigate to Reports in the sidebar. Q: Can I share my dashboard view with other users? A: Yes, you can create and share custom dashboard layouts through the Share menu in the top navigation bar. Related Articles - Basic Navigation - Camera Management - User Preferences Need More Help? If you couldn't find what you were looking for in this article: - Check our Troubleshooting Guide - Join our Community Forum - Contact Support Tags: dashboard, interface, navigation, layout, customization

Last updated on Feb 12, 2025

Basic Navigation

Overview Master the essential navigation features of Airys. This guide covers basic movements, keyboard shortcuts, and common actions to help you navigate the interface efficiently. Difficulty Level: Beginner Time Required: 10 minutes Last Updated: February 2024 Prerequisites - Active Airys account - Completed First-time Setup - Basic familiarity with web applications Table of Contents 1. Basic Controls 2. Keyboard Shortcuts 3. Mouse Navigation 4. Common Actions 5. Tips and Tricks 6. FAQ Basic Controls Essential Navigation Elements [Screenshot/Image Placeholder 1] Caption: Main navigation elements highlighted 1. Top Bar Navigation - Home button: Return to dashboard - Search bar: Quick access to features - Notifications bell: View alerts - User menu: Account options 2. Sidebar Menu - Main feature categories - Quick access to tools - Collapsible for more space - Favorites section 💡 Pro Tip: Pin frequently used items to your sidebar for quick access. Keyboard Shortcuts Global Shortcuts - ? - Show/hide shortcut list - Esc - Close current modal/popup - Ctrl + / - Focus search bar - Alt + H - Return to home - Alt + C - Open camera view Camera Controls - Space - Pause/Resume selected stream - F - Full screen current camera - 1-9 - Select camera by position - Ctrl + Arrow keys - Navigate grid Interface Controls - Ctrl + B - Toggle sidebar - Ctrl + D - Toggle dark mode - Ctrl + S - Save current settings - Alt + N - Open notifications Mouse Navigation Basic Actions [Screenshot/Image Placeholder 2] Caption: Mouse interaction zones 1. Click Actions - Left click: Select/Activate - Right click: Context menu - Double click: Expand/Collapse - Middle click: Open in new tab 2. Drag and Drop - Rearrange camera grid - Customize dashboard layout - Organize favorites - Adjust panel sizes Common Actions Frequently Used Features [Screenshot/Image Placeholder 3] Caption: Common actions menu 1. Camera Management - Click camera tile to focus - Drag to rearrange views - Right-click for camera options - Double-click for full screen 2. Navigation Flow - Use breadcrumbs to track location - Back button for previous view - Home icon for dashboard - Quick links in footer Tips and Tricks Efficiency Boosters 1. Quick Access - Use search bar for instant navigation - Create custom shortcuts - Pin frequent items - Use keyboard shortcuts 2. Layout Optimization - Collapse sidebar when needed - Arrange cameras by priority - Save custom layouts - Use grid snap guides Frequently Asked Questions Q: Can I customize keyboard shortcuts? A: Yes, you can customize shortcuts in Settings > Keyboard > Custom Shortcuts. Q: How do I quickly find a specific camera? A: Use the search bar (Ctrl + /) and type the camera name or location. Q: Can I navigate between pages using keyboard only? A: Yes, use Tab to move between elements and Enter to select. Use keyboard shortcuts for faster navigation. Related Articles - Understanding the Dashboard - Customizing Your Interface - Camera Grid Management Need More Help? If you couldn't find what you were looking for in this article: - Check our Troubleshooting Guide - Join our Community Forum - Contact Support Tags: navigation, shortcuts, controls, interface, basic-usage

Last updated on Feb 12, 2025