Get Started
Your Journey to Open-Source Commerce Starts Here
Whether you're launching a new store, migrating from Magento Open Source, or setting up a development environment—we have a clear path to get you running quickly.
Choose Your Path
How Would You Like to Start?
Select the guide that best matches your situation. Each path is designed to get you to a working Mage-OS installation as quickly as possible.
Quick Start
New to Mage-OS? Get a working store in 15-30 minutes with our streamlined guide. Covers Composer setup, basic configuration, and your first storefront.
Migration from Magento
Already running Magento Open Source? Migrate in as little as 15 minutes with full extension compatibility. Includes rollback procedures and testing checklist.
Detailed Installation
Explore detailed installation methods for Docker, cloud hosting, local development, and production environments.
System Requirements
Planning your infrastructure? Review PHP versions, database options, search engines, and hosting requirements before you begin.
Quick Start Preview
Here's what you'll accomplish in our Quick Start guide
Step 1: Install via Composer
One command gets you started: composer create-project --repository-url=https://repo.mage-os.org/ mage-os/project-community-edition .
Step 2: Configure Your Store
Run the setup wizard to connect your database, create an admin account, and configure basic store settings like currency and locale.
Step 3: Build & Deploy
Compile dependency injection, deploy static assets, and clear the cache. These commands prepare your store for visitors.
Your Store is Live!
Access your new storefront and admin panel. From here, explore product setup, payment configuration, and shipping options.
For Magento Users
Migrating from Magento? It's Easier Than You Think
Keep What Works, Gain What's Better
Many stores have successfully migrated from Magento Open Source to Mage-OS without disruption.Full Extension Compatibility
Your existing Magento 2 extensions, themes, and customizations work seamlessly with Mage-OS.
Simple Composer Update
Migration is typically just a repository swap in composer.json followed by a composer update.
Rollback Ready
Our guide includes complete rollback procedures so you can migrate with confidence.
Prerequisites
What You'll Need
Most modern hosting environments meet these requirements. Check our detailed system requirements page for compatibility notes.
With required extensions (intl, soap, gd, etc.)
For product, customer, and order data
Manages PHP dependencies and updates
Powers catalog and site search
Handles cache and session storage
Serves your storefront to visitors
Choose Your Environment
Deployment Options
Mage-OS runs anywhere Magento does. Here are the most common deployment scenarios.
Local Development
Use Docker with DDEV, Warden, or docker-magento for a consistent, isolated development environment. Perfect for building extensions, testing upgrades, or local debugging.
Cloud Hosting
Deploy to AWS, Google Cloud, Azure, or specialized Magento hosts. Scalable and managed options available.
Dedicated Servers
Full control with VPS or bare metal. Ideal for agencies managing multiple stores or businesses with specific compliance requirements.
Enterprise Infrastructure
Multi-server setups with load balancers, separate database clusters, Redis clusters, and CDN integration for maximum performance and reliability.
Getting Started FAQs
Common Questions
Do I need to be a developer to install Mage-OS?
Basic command-line knowledge is helpful, but our Quick Start guide walks you through each step.
Can I migrate from Adobe Commerce?
Mage-OS is based on Magento Open Source. If you are using Adobe Commerce-specific features, some additional planning may be required. Contact our community for guidance on your specific situation.
What support is available during setup?
Our Discord community has active channels for installation help. You can also find partner agencies offering professional installation and migration services.
How long does migration from Magento take?
A straightforward migration typically takes 15-30 minutes. Complex stores with many customizations should plan additional time for testing but rarely exceed a few hours.
Ready to Begin Your Mage-OS Journey?
Choose your path: new installations start with our Quick Start guide, while existing Magento stores should check out the Migration Guide. Either way, you'll be running Mage-OS in no time.
