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