diff --git a/README.md b/README.md index 73b9d26..053ee5d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,118 @@ -# odbc-migration-kit +

+ ODBC Migration Kit Banner +

-Backup and restore all Windows ODBC DSNs and drivers in one click. \ No newline at end of file +## πŸš€ What this does + +This kit: + +- Saves all ODBC **drivers, DSNs, and registry settings** +- Builds a single `.zip` backup package +- Automatically lists **vendor download links** (Microsoft, Oracle, MySQL, PostgreSQL, etc.) +- Recreates everything on a new computer in one click + +--- + +## πŸ–₯️ Requirements + +- Windows 10 or 11 +- Administrator permissions +- PowerShell 5.1 or higher + +--- + +## 🧰 Files Included + +| File | Purpose | +| -------------------------- | ----------------------------------------------------- | +| `export-ODBC.ps1` | Run this on the **old computer** to export settings | +| `restore-ODBC.ps1` | Run this on the **new computer** to import everything | +| `ODBC_Backup.zip` | The automatically created backup package | +| `ODBC_Migration_Report.md` | Report with driver download links | + +--- + +## πŸ“€ Step 1 β€” Backup (Old Computer) + +1. **Right-click** `export-ODBC.ps1` β†’ **Run with PowerShell (Admin)** + +2. Wait until you see: + + ``` + Export complete. ZIP created at: C:\ODBC_Migration\ODBC_Backup.zip + ``` + +3. Copy that `ODBC_Backup.zip` file to a USB drive or cloud folder. + +--- + +## πŸ“₯ Step 2 β€” Restore (New Computer) + +1. Copy the `ODBC_Backup.zip` file to `C:\ODBC_Migration\` +2. **Right-click** `restore-ODBC.ps1` β†’ **Run with PowerShell (Admin)** +3. The script will: + - Extract your backup + - Recreate DSNs + - Import registry keys + - Tell you which drivers are missing (with clickable download links) + +Example output: + +``` +=== Missing ODBC Drivers Detected === + - ODBC Driver 18 for SQL Server (64-bit) + Download: https://learn.microsoft.com/sql/connect/odbc/download-odbc-driver-for-sql-server +``` + +4. Install missing drivers if needed. + Then re-run `restore-ODBC.ps1` one more time (safe to run twice). + +--- + +## πŸ“¦ Files Created During Backup + +``` +C:\ODBC_Migration\ + β”œβ”€β”€ ODBC_Backup.zip + β”œβ”€β”€ export_log.txt + β”œβ”€β”€ export\ + β”‚ β”œβ”€β”€ ODBC_Migration_Report.md + β”‚ β”œβ”€β”€ odbc_driver_product_map.csv + β”‚ β”œβ”€β”€ odbc_installer_hits.csv + β”‚ β”œβ”€β”€ odbc_drivers.csv + β”‚ β”œβ”€β”€ odbc_dsns.xml + β”‚ β”œβ”€β”€ ODBC_System.reg + β”‚ β”œβ”€β”€ ODBC_User.reg + β”‚ └── ODBC_System32.reg +``` + +--- + +## πŸ› οΈ Troubleshooting + +| Issue | Fix | +| ------------------------------------------- | --------------------------------------------------------------------- | +| PowerShell says β€œscript execution disabled” | Open PowerShell as admin β†’ `Set-ExecutionPolicy RemoteSigned` | +| ZIP not created | Ensure there’s enough space on `C:\` and that PowerShell ran as admin | +| Missing driver link says β€œSearch manually” | Use the Markdown report to see full list of known download sites | +| Restore errors out | Run again after installing missing drivers | + +--- + +## πŸ§‘β€πŸ’» Technical Details (for advanced users) + +- Uses `Get-OdbcDsn`, `Get-OdbcDriver`, and registry exports +- Detects installed products from `HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall` +- Generates CSV and Markdown reports with official vendor links +- Compressed using `Compress-Archive` built into PowerShell +- Logs stored in `C:\ODBC_Migration` + +--- + +## 🧑 Credits + +Created by **Gene Amos** for easy ODBC migration between home or work PCs. +Licensed under MIT. +Feel free to fork and improve. + +--- diff --git a/assets/odbc_migration_kit_banner.png b/assets/odbc_migration_kit_banner.png new file mode 100644 index 0000000..3390f21 Binary files /dev/null and b/assets/odbc_migration_kit_banner.png differ diff --git a/assets/odbc_migration_kit_logo.png b/assets/odbc_migration_kit_logo.png new file mode 100644 index 0000000..93b1ed4 Binary files /dev/null and b/assets/odbc_migration_kit_logo.png differ