Documentation

External Resources

Installation

Install S3 Migration Scheduler on your platform - Docker, Windows, Linux, or build from source.

Installation Guide

S3 Migration Scheduler is available for all major platforms. Choose the installation method that works best for your environment.

Docker

Docker is the fastest way to get started. No installation required, works everywhere Docker runs.

Prerequisites

  • Docker 20.10 or later
  • At least 2GB RAM
  • Network access to your S3 endpoints

Quick Start

# Pull the latest image
docker pull hndrwn/s3-migration-scheduler:latest

# Run the container
docker run -d \
  --name s3-migration-scheduler \
  -p 5000:5000 \
  -e NODE_ENV=production \
  -v s3-migration-data:/app/data \
  -v s3-migration-logs:/app/logs \
  hndrwn/s3-migration-scheduler:latest

# Access web interface
open http://localhost:5000

Docker Compose (Production)

Create a docker-compose.yml file:

services:
  s3-migration-scheduler:
    build:
      context: .
      dockerfile: Dockerfile
    container_name: s3-migration-scheduler
    ports:
      - "5000:5000"
    environment:
      - NODE_ENV=production
      - PORT=5000
      - FRONTEND_URL=http://localhost:5000
    volumes:
      # Persist database and logs
      - ./data:/app/data
      - ./logs:/app/logs
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:5000/api/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s
    networks:
      - s3-migration-network

networks:
  s3-migration-network:
    driver: bridge

volumes:
  data:
  logs:

Run with Docker Compose:

# Start the application
docker-compose up -d

# Stop the application
docker-compose down

# Restart the application
docker-compose restart

# View real-time logs
docker-compose logs -f

# View logs with timestamps
docker-compose logs -t

Docker Hub

Visit hndrwn/s3-migration-scheduler on Docker Hub for more information and tags.

Desktop Applications

Native desktop applications with GUI interface for easy migration management.

Windows

System Requirements

  • Windows 10 or later
  • At least 2GB RAM
  • 1GB free disk space

Download Options

Windows Installer (x64) - Recommended for most users

https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/S3.Migration.Scheduler-1.1.0-win-x64.exe

Portable Version (x64) - No installation required

https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/S3.Migration.Scheduler-1.1.0-portable-x64.exe

Or visit the Downloads page for the latest versions.

Installation Steps

  1. Download the Windows installer (.exe) from above
  2. Run the installer as Administrator if prompted
  3. Follow the setup wizard to complete installation
  4. Launch from Start Menu or Desktop shortcut

Configuration Locations

  • Settings: %APPDATA%\S3MigrationScheduler\config.yml
  • Logs: %APPDATA%\S3MigrationScheduler\logs\
  • Data: %APPDATA%\S3MigrationScheduler\data\

Older Windows Platforms

For Windows 7, 8, or other legacy versions, please check the GitHub Releases page for compatible versions.

Linux

System Requirements

  • Modern Linux distribution (Ubuntu 20.04+, CentOS 8+, etc.)
  • At least 4GB RAM
  • 500MB free disk space

Download Options

AppImage (Universal) - Works on most Linux distributions

https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/S3.Migration.Scheduler-1.1.0.AppImage

Debian/Ubuntu (.deb)

https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/s3-migration-scheduler-desktop_1.1.0_amd64.deb

Red Hat/Fedora (.rpm)

https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/s3-migration-scheduler-desktop-1.1.0.x86_64.rpm

Tarball (.tar.gz)

https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/s3-migration-scheduler-desktop-1.1.0.tar.gz

AppImage Installation

The AppImage format works on most Linux distributions without installation:

# Download AppImage
wget https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/S3.Migration.Scheduler-1.1.0.AppImage

# Make executable
chmod +x S3.Migration.Scheduler-1.1.0.AppImage

# Run directly
./S3.Migration.Scheduler-1.1.0.AppImage

Debian/Ubuntu (.deb)

# Download
wget https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/s3-migration-scheduler-desktop_1.1.0_amd64.deb

# Install
sudo dpkg -i s3-migration-scheduler-desktop_1.0.0_amd64.deb
sudo apt-get install -f  # Fix dependencies if needed

# Start the application
s3-migration-scheduler-desktop

Red Hat/Fedora (.rpm)

# Download and install
wget https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/s3-migration-scheduler-desktop-1.1.0.x86_64.rpm
sudo rpm -i s3-migration-scheduler-desktop-1.1.0.x86_64.rpm

# Or using dnf
sudo dnf install s3-migration-scheduler-desktop-1.1.0.x86_64.rpm

# Start the application
s3-migration-scheduler-desktop

Tarball (Generic)

# Download and extract
wget https://github.com/hndrwn-dk/s3-migration-scheduler/releases/download/v1.1.0/s3-migration-scheduler-desktop-1.1.0.tar.gz
tar -xzf s3-migration-scheduler-desktop-1.1.0.tar.gz
cd s3-migration-scheduler-desktop

# Run directly and extract
./s3-migration-scheduler-desktop

# Optional: Install system-wide
sudo cp s3-migration-scheduler-desktop.desktop /usr/local/bin/
sudo cp s3-migration-scheduler-desktop.desktop.app /usr/share/applications/
sudo cp icons/* /usr/share/icons/hicolor/256x256/apps/

Build from Source

For developers and contributors who want to build from source.

Prerequisites

  • Node.js 18 or later
  • npm or yarn
  • Git

Build Steps

# Clone the repository
git clone https://github.com/hndrwn-dk/s3-migration-scheduler.git
cd s3-migration-scheduler

# Install dependencies
npm install

# Build the application
npm run build

# Start the application
npm start

Health Check

# Web interface health check
curl http://localhost:8080/health

# Expected response
{
  "status": "healthy",
  "version": "1.0.0",
  "uptime": "5m30s",
  "database": "connected",
  "storage": "accessible"
}

Getting Help

If you encounter issues during installation:

  1. Check the Troubleshooting Guide
  2. Search GitHub Issues
  3. Ask for help in Discussions
  4. Join our community chat (link in repository)

Next Steps

After successful installation:

  1. Quick Start Guide - Run your first migration
  2. Configuration - Customize for your needs
  3. Migration Workflows - Learn best practices

Having trouble? Check our FAQ or reach out to the community for help.