Skip to content

📋 Quick Reference

Essential information at your fingertips

🚀 Quick Start Commands

🛠️ Development Environment

# Clone repository
git clone https://gitlab.com/appgain.io/generic.git
cd generic/appgain-onboarding-site

# Build documentation
mkdocs build

# Deploy to server
./deploy-mkdocs.sh

# Start development server
mkdocs serve

🖥️ Server Access

# Core Production Servers
ssh ubuntu@ovh-appgain-server    # Main application server
ssh ubuntu@ovh-parse-server      # Parse server and APIs
ssh ubuntu@ovh-kong              # API Gateway
ssh ubuntu@ovh-pushsender        # Push notification service

# Development & Staging
ssh ubuntu@ovh-devops            # DevOps and staging
ssh ubuntu@ovh-preprod           # Pre-production testing

# Database Servers
ssh ubuntu@ovh-mongo-master      # MongoDB primary
ssh ubuntu@ovh-mongo-slave1      # MongoDB replica 1
ssh ubuntu@ovh-mongo-slave2      # MongoDB replica 2

🤖 AI-Powered Product Support

First Stop for Product Questions: Chehab

Before asking team members, try our AI assistant trained on all Appgain products and integrations.

💬 Chehab - Appgain's Tech Architect

💡 Pro Tip: Always try Chehab first for product questions - it can answer most queries instantly!


🔗 Essential URLs

📚 Documentation & Resources

Resource URL Access
📖 Live Documentation https://devdocs.appgain.io Public
🔧 GitLab Repository https://gitlab.com/appgain.io Team
📋 Confluence https://appgain.atlassian.net Team
🎯 JIRA https://appgain.atlassian.net Team
🐍 Microservice Blueprint AppGain Microservice Blueprint Internal

📊 Monitoring & Status

Service URL Credentials
📈 Grafana http://monitor.instabackend.io:3003 Ask manager
📊 Status Page https://status.instabackend.io/ Public
🔍 Prometheus http://monitor.instabackend.io:9090 Internal
🚨 Alertmanager http://monitor.instabackend.io:9093 Internal
🛠️ Admin Dashboard https://admin-dashboard.instabackend.io Support Engineer

🌐 Platform URLs

Platform URL Purpose
🚀 Appgain.io https://appgain.io Main platform
🔧 Appgain.co https://appgain.co Development
🛒 Shrinkit.me https://shrinkit.me URL shortening
🩺 iKhair.net https://ikhair.net Donation Payment
🛍️ Nabolia.net https://nabolia.net E-commerce

📚 Foundation Courses

✅ Required for All Roles

🎯 Role-Specific Courses

  • 🤖 AI Engineer: Python, Machine Learning, LLAMA
  • 📊 Data Engineer: Data Science, ETL, Analytics
  • 🔧 DevOps Engineer: Docker, Kubernetes, CI/CD
  • ⚙️ Backend Engineer: Node.js, Python, APIs
  • 🎨 Frontend Engineer: React 18, TypeScript, Web Development
  • 📱 Mobile Engineer: React Native, Flutter, Mobile Development

🏗️ System Architecture Quick Reference

🔄 Core Flow

API Gateway (KONG) → Application Services → Data Layer
     ↓                    ↓                    ↓
Load Balancing    Appgain Server        MongoDB Clusters
Request Routing   Parse Server          Redis Cache
Authentication    Notify Service        PostgreSQL (KONG)
Rate Limiting     Automator Engine      File Storage

🔧 Key Services

Service Purpose Technology Port
API Gateway Request routing & auth KONG 8000, 8443
Appgain Server Core business logic Node.js 3000
Parse Server Backend-as-a-Service Node.js 1337
Notify Service Multi-channel messaging Node.js 3001
Automator Engine Workflow automation Python 5000
Task Queue Background processing Redis/Bull 6379
Push Sender Push notifications Node.js 3002
Admin Server Management interface Flask 5000

🛠️ Common Commands

🔧 Git Operations

# Clone repository
git clone https://gitlab.com/appgain.io/generic.git

# Check status
git status

# Add changes
git add .

# Commit changes
git commit -m "Your commit message"

# Push to remote
git push origin master

# Pull latest changes
git pull origin master

🐳 Docker Operations

# List containers
docker ps

# List images
docker images

# Run container
docker run -d --name container_name image_name

# Stop container
docker stop container_name

# Remove container
docker rm container_name

# View logs
docker logs container_name

📊 Database Operations

# MongoDB connection
mongo --host localhost --port 27017 database_name

# Redis connection
redis-cli -h localhost -p 6379

# PostgreSQL connection
psql -h localhost -p 5432 -U username database_name

📊 Performance Metrics

🎯 Key Performance Indicators

Metric Target Current Status
Platform Uptime >99.9% ✅ Achieving
API Response Time <250ms ✅ Achieving
Database Performance <100ms ✅ Achieving
Push Delivery Rate >95% ✅ Achieving
Email Delivery Rate >99% ✅ Achieving

📈 System Capacity

Component Capacity Current Usage
API Gateway 10,000 req/sec 2,000 req/sec
Database 1M operations/sec 500K operations/sec
Push Notifications 100K/min 50K/min
Email Service 10K/min 5K/min

🚨 Emergency Contacts

🆘 Critical Issues

  • 🚨 System Down: Contact DevOps team immediately
  • 🔒 Security Breach: Contact security team
  • 💰 Payment Issues: Contact finance team
  • 👥 Customer Impact: Contact support team

📞 Emergency Numbers

  • 🔧 DevOps: [Contact DevOps team]
  • 🛡️ Security: [Contact Security team]
  • 💰 Finance: [Contact Finance team]
  • 👥 Support: [Contact Support team]

📋 Daily Checklist

✅ Morning Routine

  • Check system status
  • Review monitoring dashboards
  • Check for critical alerts
  • Review team communications
  • Plan daily tasks

✅ End of Day

  • Update task progress
  • Commit code changes
  • Update documentation
  • Check tomorrow's schedule
  • Log out of systems

🎯 Quick Actions

🚀 Common Tasks

Task Command/URL Purpose
Check System Status https://status.instabackend.io/ Monitor system health
Access Grafana http://monitor.instabackend.io:3003 View metrics
Ask AI Assistant Ask Chehab Get instant help
Access Documentation https://devdocs.appgain.io View docs
GitLab Repository https://gitlab.com/appgain.io Access code

🛠️ Development Tasks

Task Command Purpose
Start Dev Server mkdocs serve Local documentation
Build Docs mkdocs build Generate static site
Deploy Docs ./deploy-mkdocs.sh Deploy to production
Check Git Status git status View changes
Pull Latest git pull origin master Update local repo

📞 Support Channels

🤖 AI Assistant (First Choice)

  • 💬 Chehab: Ask Chehab
  • Best For: Technical questions, product guidance
  • Response Time: Instant

👥 Human Support


Bookmark this page for quick access to essential commands, URLs, and resources. Remember to try Chehab first for any questions!

Ask Chehab GPT