https://github.com/j-scriptz/mage-mirror
Magento 2 - Fresh Install, Clone, or Upgrade Live Site for Dev. Uses Warden, optional Hyva Theme install.
https://github.com/j-scriptz/mage-mirror
automation dev-environment docker docker-compose hyva hyva-themes installer magento magento-2 magento-rsync magento2 warden
Last synced: about 1 month ago
JSON representation
Magento 2 - Fresh Install, Clone, or Upgrade Live Site for Dev. Uses Warden, optional Hyva Theme install.
- Host: GitHub
- URL: https://github.com/j-scriptz/mage-mirror
- Owner: j-scriptz
- License: gpl-3.0
- Created: 2025-11-27T05:13:21.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-12-18T16:45:27.000Z (4 months ago)
- Last Synced: 2025-12-21T20:35:13.921Z (4 months ago)
- Topics: automation, dev-environment, docker, docker-compose, hyva, hyva-themes, installer, magento, magento-2, magento-rsync, magento2, warden
- Language: Shell
- Homepage:
- Size: 1.82 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 mage-mirror
### The Fastest Way to Spin Up Magento + Warden + Hyvä — On macOS & Linux
Fresh installs, Hyvä auto-setup, remote cloning, Magento upgrades, and multi-store routing — all from one script.
**One command. Zero frustration.**
## 🏷️ Badges
---
## 🎥 Quick Demo
---
## 🌟 What is mage-mirror?
mage-mirror is a high-speed Magento development environment generator built for Warden, Docker, and Hyvä.
It automates:
- Fresh Magento installs
- Hyvä theme installation
- Cloning local or remote sites
- Magento upgrades
- Multi-store routing
- SSH sync via rsync or tar
- OpenSearch reconfiguration
- Full Warden environment setup
Everything runs through:
- `_mage-mirror.sh`
- `_mage-mirror.config`
---
## 🏁 Quick Start
```bash
git clone https://github.com/j-scriptz/mage-mirror.git
cd mage-mirror
chmod +x _mage-mirror.sh
```
then
```bash
./_mage-mirror.sh
```
or
```bash
sh _mage-mirror.sh
```
Environment URLs:
- https://mage.test
- https://app.mage.test (if multi-store enabled)
---
## 🔐 SSH Key Setup (Local → Remote Server)
If you plan to use **remote cloning**, **rsync**, or **remote DB dumps**, set up SSH keys so your local machine can authenticate to your server without repeatedly entering a password.
### 1) Generate an SSH key on your local machine
**macOS / Linux (recommended: Ed25519)**
```bash
ssh-keygen -t ed25519 -C "your_email@example.com"
```
- Press **Enter** to accept the default path: `~/.ssh/id_ed25519`
- Add a **passphrase** (recommended)
If Ed25519 isn’t supported in your environment, use RSA:
```bash
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```
### 2) Start the SSH agent and add your key
```bash
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519
```
*(If you created an RSA key, replace `id_ed25519` with your key filename.)*
### 3) Add your public key to the remote server
#### Option A: `ssh-copy-id` (easiest, if available)
```bash
ssh-copy-id -i ~/.ssh/id_ed25519.pub youruser@yourserver.com
```
#### Option B: Manual (works everywhere)
1) Print your public key:
```bash
cat ~/.ssh/id_ed25519.pub
```
2) SSH into your server (password-based login once):
```bash
ssh youruser@yourserver.com
```
3) On the server, create `.ssh`, paste the key, and lock permissions:
```bash
mkdir -p ~/.ssh
chmod 700 ~/.ssh
nano ~/.ssh/authorized_keys
# Paste the full public key line, save, exit
chmod 600 ~/.ssh/authorized_keys
```
### 4) Test SSH login
```bash
ssh -i ~/.ssh/id_ed25519 youruser@yourserver.com
```
### Optional: Simplify with `~/.ssh/config`
Create or edit `~/.ssh/config`:
```sshconfig
Host myserver
HostName yourserver.com
User youruser
IdentityFile ~/.ssh/id_ed25519
```
Then connect with:
```bash
ssh myserver
```
### Troubleshooting
- `Permission denied (publickey)` usually means:
- the key wasn’t added to `authorized_keys`,
- permissions are wrong (`~/.ssh` should be `700`, `authorized_keys` should be `600`),
- or you’re connecting as the wrong user.
- Non-standard SSH port:
```bash
ssh -p 2222 youruser@yourserver.com
```
---
## 🚀 Key Features
### ⚡ Fresh Magento Installs
- Composer create-project
- Admin creation
- Hyvä auto-install
- Sample data support
- DI compile + static deploy
- OpenSearch configuration
---
### 🔁 Clone Magento Sites
Supports:
- Local SQL + env.php/config.php
- Remote over SSH
- Remote DB via mysqldump
- Remote rsync/tar sync modes
Modes:
- Code only
- DB only
- Code + DB
- Code + DB (no media)
- Full sync
---
### ⬆️ Magento Upgrade Mode
```bash
UPGRADE_MAGENTO=yes
UPGRADE_MAGENTO_VERSION=2.4.*
```
mage-mirror will:
1. Import site
2. Adjust Composer constraints
3. Run composer update
4. Run setup:upgrade
5. Build static assets
---
### 🌐 Multi-Store Routing
| Domain | Website |
|---------------|---------|
| app.mage.test | base |
| mage.test | subcats |
Also:
- Writes to `/etc/hosts`
- Patches pub/index.php
- Sets base URLs
---
## ⚙ Configuration: `_mage-mirror.config`
Example:
```bash
PROJECT_NAME=mage
MAGENTO_VERSION=2.4.*
INSTALL_HYVA=ask
WITH_SAMPLE_DATA=ask
USE_EXISTING_DB=ask
USE_RSYNC_MAGENTO=ask
USE_REMOTE_DB_DUMP=no
ENABLE_MULTISTORE=ask
UPGRADE_MAGENTO=ask
UPGRADE_MAGENTO_VERSION=2.4.*
```
Supports: yes, no, ask
---
## 🧪 Example Commands
### Fresh install (Hyvä + sample data)
```bash
PROJECT_NAME=mage USE_EXISTING_DB=no WITH_SAMPLE_DATA=yes INSTALL_HYVA=yes ./_mage-mirror.sh
```
### Clone from local dump
```bash
PROJECT_NAME=mage USE_EXISTING_DB=yes EXISTING_DB_SQL=db/site.sql EXISTING_ENV_PHP=config/env.php ./_mage-mirror.sh
```
### Clone remote + upgrade
```bash
PROJECT_NAME=mage USE_EXISTING_DB=yes USE_RSYNC_MAGENTO=yes USE_REMOTE_DB_DUMP=yes UPGRADE_MAGENTO=yes UPGRADE_MAGENTO_VERSION=2.4.* ./_mage-mirror.sh
```
---
## ❤️ Optional: Jscriptz Subcats
Hyvä + Luma compatible subcategory card module:
https://mage.jscriptz.com/jscriptz-subcats.html
---
## 🤝 Contributing
PRs and feature requests welcome.
If mage-mirror saved you time:
**⭐ Please star the repo — it helps visibility!**
---
## 📄 License
GNU Public License v3.0