Installation
Get up and running in 5 simple steps
Complete installation guide for ATStatus. Get up and running in just 5 simple steps!
System Requirements
| Resource | Minimum | Recommended |
|---|---|---|
| Node.js | 18.0+ | 20.0+ (LTS) |
| RAM | 2 GB | 4 GB |
| Storage | 10 GB | 20 GB |
| CPU | 1 core | 2+ cores |
| OS | Windows, macOS, or Linux | |
Storage Breakdown: 10 GB minimum includes Node.js (~300MB), npm packages (~1.5GB), build artifacts (~500MB), database growth (~2GB typical), and room for logs and backups.
No External Database Required! ATStatus uses SQLite by default, which is embedded. No need to install or configure a separate database server.
Quick Start (5 Steps)
1
Extract the Package
Extract the ATStatus package (statuspage-clean) to your desired location.
2
Open Terminal
Open CMD (Windows), Terminal (macOS/Linux), or PowerShell and navigate to the folder.
3
Install Dependencies
Run npm install to download all required packages.
4
Run Setup
Run npm run setup to generate Prisma client, create database, and configure .env file.
5
Start the Application
Run npm start and visit http://localhost:3000.
Installation Commands
# Navigate to the folder
cd path/to/statuspage-clean
# Install dependencies
npm install
# Run setup
npm run setup
# Start the application
npm start
🎉 Done!
Your status page is now running at http://localhost:3000
Configuration
Edit the .env file in your statuspage folder to customize your installation:
# Database (SQLite - no external database needed)
DATABASE_URL="file:./data.db"
# Admin credentials - CHANGE THESE IN PRODUCTION!
ADMIN_PASSWORD="your-secure-password"
SESSION_SECRET="change-this-to-a-long-random-string"
CRON_SECRET="change-this-to-another-random-string"
# Network Access Settings
TRUST_PROXY="false"
FORCE_SECURE_COOKIES="false"
LAN/Network Access: If you need to access the status page from other devices on your network via HTTP, set
FORCE_SECURE_COOKIES="false" in your .env file.First Login
- Navigate to
/adminin your browser - Login with:
- Username:
admin - Password: The ADMIN_PASSWORD from your .env file
- Username:
Security Warning: Always change the default ADMIN_PASSWORD, SESSION_SECRET, and CRON_SECRET before deploying to production!
Access Points
Public Status Page
http://localhost:3000
Admin Console
http://localhost:3000/admin
Incident History
http://localhost:3000/history
