Quick Start Guide

Quick Start Overview

This quick start guide will get you up and running with MegaVault in under 10 minutes. We'll cover the essential setup steps and get you uploading files right away.

Prerequisites

Before diving into the setup, let's ensure you have everything needed for a smooth installation.

Required Services

Development Environment

Account Setup

1. Cloudflare Account: Sign up at cloudflare.com
2. Create R2 Bucket: Go to R2 Object Storage and create a new bucket
3. Generate API Tokens: Create API tokens with R2 permissions
4. Redis Database: Set up a Redis instance (Upstash recommended for beginners)

5-Minute Setup

Follow these steps to get MegaVault running quickly. This setup will get you a working instance that you can start using immediately.

git clone https://github.com/iotserver24/S3-MegaVault.git
cd S3-MegaVault
npm install

# Copy the environment template
cp .env.example .env.local

# Edit the configuration file (use your preferred editor)
nano .env.local

# Required settings:
NEXTAUTH_SECRET=your-secret-key-here
REDIS_URL=your-redis-connection-string
R2_ACCOUNT_ID=your-cloudflare-account-id
R2_ACCESS_KEY_ID=your-access-key
R2_SECRET_ACCESS_KEY=your-secret-key
R2_BUCKET_NAME=your-bucket-name

# For S3-compatible services (S3, R2, DigitalOcean, etc.)
aws s3api put-bucket-cors \
  --bucket YOUR_BUCKET_NAME \
  --cors-configuration file://cors.json \
  --endpoint-url YOUR_ENDPOINT_URL

# For Google Cloud Storage
gsutil cors set cors.json gs://YOUR_BUCKET_NAME

# See detailed instructions at:
# /docs/getting-started/cors-setup

# If using Docker
docker-compose up -d

# If using manual setup
npm run dev

# Access MegaVault at:
http://localhost:3001

# Navigate to the signup page
http://localhost:3001/auth/signup

# Fill in your details:
- Full Name
- Email Address
- Strong Password
- Confirm Password

# Check your email for verification link

Verification Steps

1. Access the Web Interface: Open http://localhost:3001 in your browser
2. Login: Use the credentials you created during setup
3. Dashboard Check: Verify the dashboard loads without errors
4. Upload Test: Try uploading a small test file

Common Setup Issues

Your First Upload

Now that MegaVault is running, let's upload your first file and explore the basic features.

Web Upload

1. Navigate to Dashboard: Go to the main dashboard after logging in
2. Upload Area: Look for the drag-and-drop upload area
3. Choose Files: Drag files to the upload area or click to select
4. Monitor Progress: Watch the upload progress indicator
5. Verify Upload: Check that files appear in your file list

Upload Methods

File Management Basics

• View Files: Browse uploaded files in grid or list view
• Preview: Click files to preview supported formats
• Download: Right-click and select download
• Share: Generate secure sharing links
• Organize: Create folders and move files
• Search: Use the search bar to find files quickly

# Test API upload (optional)
curl -X POST http://localhost:3001/api/upload   -H "Authorization: Bearer YOUR_API_TOKEN"   -F "file=@test-file.txt"   -F "folder=/"

# Expected response:
{
  "success": true,
  "file": {
    "id": "file_123",
    "name": "test-file.txt",
    "size": 1024,
    "url": "/api/files/file_123"
  }
}

Mobile App Setup

Complete your MegaVault setup by installing and configuring the mobile app for on-the-go file access and automatic photo backup.

Mobile App Installation

Mobile App Configuration

1. Server Setup: Enter your MegaVault server URL
2. Login: Use the same credentials from web setup
3. Permissions: Grant necessary permissions (storage, camera, notifications)
4. Sync Settings: Configure automatic photo backup
5. Test Upload: Take a photo and verify it uploads automatically

Essential Mobile Features

• Auto Photo Backup: Automatically backup new photos and videos
• Offline Access: Download files for offline viewing
• Background Uploads: Continue uploads when app is closed
• Push Notifications: Get notified about uploads and shares
• File Sharing: Share files directly from other apps

Next Steps

Now that you have MegaVault up and running, here are the next steps to get the most out of your file storage solution.

Immediate Next Steps

Learning Resources

• User Guide: Comprehensive documentation for daily use
• Admin Guide: Advanced configuration and management
• API Documentation: Build integrations and automations
• Community: Join the MegaVault community for support
• Updates: Follow release notes for new features

Advanced Configuration

• Custom Domain: Set up your own domain name
• Email Configuration: Configure SMTP for notifications
• Integration Setup: Connect with other tools and services
• Team Management: Set up user accounts and permissions
• Automation: Create automated workflows and rules