unai/docs/USER_GUIDE.md

White-Label University Portal - User Guide

📚 Table of Contents

1. Getting Started
2. University Setup
3. Content Management
4. Program Management
5. Domain Management
6. Asset Management
7. AI Configuration
8. Deployment
9. Troubleshooting
10. FAQ

---

🚀 Getting Started

Welcome to the White-Label University Portal

The White-Label University Portal is a comprehensive platform that allows universities to create and manage their own branded web presence. This guide will walk you through setting up and managing your university portal.

System Requirements

• Browser: Chrome 90+, Firefox 88+, Safari 14+, Edge 90+
• Internet: Stable broadband connection
• Permissions: Admin access to your university portal

First-Time Login

1. Access the Admin Panel

   • Navigate to your-domain.com/admin
   • Use your provided credentials to log in

2. Complete Initial Setup

   • Configure your university information
   • Upload your branding assets
   • Set up your domain configuration

---

🏫 University Setup

Basic Information

Start by configuring your university's basic information:

1. University Details

   • Name: Your full university name
   • Short Name: Abbreviated name (e.g., "UTAS")
   • Slug: URL-friendly identifier (e.g., "utas")

2. Contact Information

   • Email: Primary contact email
   • Phone: Contact phone number
   • Address: Physical address
   • Website: Current website URL

3. Social Media

   • Facebook, Twitter, LinkedIn, Instagram links

Branding Configuration

Configure your university's visual identity:

1. Logo Upload

   • Format: PNG, JPG, SVG (recommended: SVG)
   • Size: Minimum 200x200px, maximum 2MB
   • Background: Transparent or white background

2. Color Scheme

   • Primary Color: Main brand color (hex code)
   • Secondary Color: Accent color (hex code)
   • Font Family: Choose from available fonts

3. Theme Settings

   • Light/Dark Mode: Enable automatic theme switching
   • Custom CSS: Advanced styling options

Feature Configuration

Enable or disable platform features:

• Chatbot: AI-powered student support
• Multi-Language: Bilingual content support
• Analytics: Usage and performance tracking
• Custom Domain: Your own domain name
• Advanced AI: Enhanced AI capabilities

---

📝 Content Management

Creating Content

1. Navigate to Content Management

   • Go to Admin Panel → Content Management

2. Add New Content

   • Click "Add New Content"
   • Select content type (About, News, Events, etc.)
   • Fill in required fields

3. Content Types

   • About: University information and history
   • News: Latest updates and announcements
   • Events: Upcoming events and activities
   • Research: Research highlights and publications
   • Campus: Campus information and facilities

Content Editor

The content editor supports:

• Rich Text Formatting: Bold, italic, lists, links
• Media Embedding: Images, videos, documents
• Bilingual Support: English and Arabic content
• SEO Optimization: Meta descriptions and keywords
• Scheduling: Publish content at specific times

Content Organization

• Categories: Organize content by type
• Tags: Add relevant tags for search
• Featured Content: Highlight important content
• Content Hierarchy: Create parent-child relationships

---

🎓 Program Management

Adding Academic Programs

1. Program Information

   • Title: Program name in English and Arabic
   • Description: Detailed program description
   • Level: Undergraduate, Postgraduate, PhD
   • Duration: Program length
   • Fees: Tuition and other costs

2. Program Details

   • Entry Requirements: Admission criteria
   • Campus Locations: Available campuses
   • Program Features: Special highlights
   • Career Prospects: Job opportunities

3. Program Status

   • Active: Currently accepting applications
   • Inactive: Temporarily unavailable
   • Archived: No longer offered

Program Categories

Organize programs by:

• Faculty: Engineering, Business, Arts, etc.
• Level: Undergraduate, Postgraduate, PhD
• Duration: Short-term, Long-term
• Location: Campus-specific programs

---

🌐 Domain Management

Setting Up Your Domain

1. Domain Types

   • Subdomain: your-university.main-domain.com
   • Custom Domain: your-university.edu

2. Domain Configuration

   • Domain Name: Enter your domain
   • SSL Certificate: Automatic SSL setup
   • DNS Configuration: DNS record management

3. Domain Validation

   • Ownership Verification: Verify domain ownership
   • DNS Records: Configure required DNS records
   • SSL Status: Monitor SSL certificate status

Domain Monitoring

• Uptime Monitoring: Track domain availability
• Performance Metrics: Response time and speed
• SSL Certificate: Automatic renewal monitoring
• DNS Health: DNS record validation

---

🖼️ Asset Management

Uploading Assets

1. Supported Formats

   • Images: JPG, PNG, GIF, WebP, SVG
   • Documents: PDF, DOC, DOCX, PPT, PPTX
   • Videos: MP4, WebM, MOV
   • Audio: MP3, WAV, OGG

2. Asset Types

   • Logo: University logo
   • Favicon: Browser tab icon
   • Hero Images: Main banner images
   • Gallery Images: Photo gallery
   • Documents: Official documents

3. Asset Optimization

   • Automatic Resizing: Multiple size variants
   • Format Conversion: Optimized formats
   • CDN Delivery: Fast global delivery
   • Compression: Reduced file sizes

Asset Organization

• Categories: Organize by type and purpose
• Tags: Add descriptive tags
• Alt Text: Accessibility descriptions
• Metadata: Additional information

---

🤖 AI Configuration

Chatbot Setup

1. AI Provider Configuration

   • Provider: Choose AI service provider
   • Model: Select AI model
   • API Configuration: Set up API keys

2. Knowledge Base Management

   • Add Q&A Pairs: Common questions and answers
   • Categories: Organize by topic
   • Priority: Set answer priority levels
   • Training: Improve AI responses

3. Chatbot Customization

   • Personality: Set chatbot tone and style
   • Greeting Message: Welcome message
   • Fallback Responses: Default responses
   • Language Support: Multi-language responses

AI Performance

• Response Quality: Monitor answer accuracy
• Training Data: Review and improve knowledge base
• User Feedback: Collect and analyze feedback
• Performance Metrics: Response time and success rate

---

🚀 Deployment

Environment Management

1. Development Environment

   • Testing: Test new features
   • Staging: Pre-production testing
   • Production: Live environment

2. Deployment Process

   • Automated Deployment: One-click deployment
   • Rollback: Quick rollback if needed
   • Health Checks: Automatic monitoring
   • Backup: Automatic data backup

Performance Optimization

• Caching: Redis caching for faster performance
• CDN: Global content delivery
• Database Optimization: Query optimization
• Load Balancing: Traffic distribution

---

🔧 Troubleshooting

Common Issues

1. Login Problems

   • Forgot Password: Use password reset
   • Account Locked: Contact support
   • Browser Issues: Clear cache and cookies

2. Content Issues

   • Content Not Publishing: Check publish settings
   • Media Not Loading: Verify file formats
   • Formatting Problems: Check rich text editor

3. Domain Issues

   • Domain Not Working: Check DNS configuration
   • SSL Errors: Verify SSL certificate
   • Performance Issues: Check CDN status

Getting Help

1. Support Channels

   • Email Support: support@your-domain.com
   • Live Chat: Available in admin panel
   • Documentation: This user guide
   • Video Tutorials: Step-by-step guides

2. Contact Information

   • Technical Support: 24/7 technical assistance
   • Account Management: Billing and account issues
   • Training: User training sessions

---

❓ FAQ

General Questions

Q: How long does it take to set up a new university portal? A: Basic setup takes 30-60 minutes. Full configuration with custom domain and branding typically takes 2-4 hours.

Q: Can I use my own domain name? A: Yes, you can use your own custom domain or a subdomain of the main platform.

Q: Is the platform mobile-friendly? A: Yes, the platform is fully responsive and works on all devices.

Technical Questions

Q: What file formats are supported for uploads? A: Images (JPG, PNG, GIF, WebP, SVG), Documents (PDF, DOC, DOCX), Videos (MP4, WebM), and Audio (MP3, WAV).

Q: How is data backed up? A: Automatic daily backups with 30-day retention. Additional manual backups available.

Q: What is the uptime guarantee? A: 99.9% uptime guarantee with 24/7 monitoring and support.

Billing Questions

Q: How is pricing structured? A: Pricing is based on the number of universities and features used. Contact sales for detailed pricing.

Q: Can I change my plan? A: Yes, you can upgrade or downgrade your plan at any time.

Q: Is there a free trial? A: Yes, we offer a 14-day free trial for new users.

---

📞 Support

Need Help?

• Email: support@your-domain.com
• Phone: +1 (555) 123-4567
• Live Chat: Available in admin panel
• Documentation: Complete documentation available
• Training: Scheduled training sessions

Feedback

We value your feedback! Please share your thoughts on:

• Platform usability
• Feature requests
• Bug reports
• General suggestions

---

Last Updated: January 2025
Version: 1.0
Platform: White-Label University Portal