![\"Medusa](\"https://raw.githubusercontent.com/anubus298/medusa-backup/main/metadata/icon_medusa_backup.svg\"){kind=icon}
\r\n\r\n \r\n
\r\n Database backup plugin for Medusa v2.10+ with improved reliability\r\n
\r\n\r\n---\r\n\r\n## ✨ What’s New in This Fork\r\n\r\nThis project is a fork of [AmeerRizvi/medusa-backup](https://github.com/AmeerRizvi/medusa-backup), updated and optimized with the following improvements:\r\n\r\n- ✅ Full compatibility with **Medusa v2.10+**\r\n- ✅ **Automatic rollback** → if a backup fails midway, the database is safely restored to its previous state\r\n\r\n---\r\n\r\n## 🚀 Installation\r\n\r\nIf published under your npm scope (example: `@anubus298/medusa-backup`):\r\n\r\n```bash\r\nnpm i @anubus298/medusa-backup\r\n```\r\n\r\nOr install directly from GitHub:\r\n\r\n```bash\r\nnpm install github:anubus298/medusa-backup\r\n```\r\n\r\n---\r\n\r\n## ⚙️ Configuration\r\n\r\n### `medusa.config.ts`\r\n\r\n```ts\r\nmodule.exports = defineConfig({\r\n ...,\r\n plugins: [\r\n {\r\n resolve: \"@anubus298/medusa-backup\",\r\n options: {},\r\n },\r\n ],\r\n})\r\n```\r\n\r\nRun database migrations:\r\n\r\n```bash\r\nnpx medusa db:migrate\r\n```\r\n\r\n---\r\n\r\n## 🔑 Environment Variables\r\n\r\nDefault setup:\r\n\r\n```dotenv\r\nDATABASE_URL=postgres://[USERNAME]:[PASSWORD]@[HOST]/[DB]\r\n```\r\n\r\nIf you separate the DB base and name:\r\n\r\n```dotenv\r\nDB_BASE=postgres://[USERNAME]:[PASSWORD]@[HOST]\r\nDB_NAME=[DB]\r\n```\r\n\r\n---\r\n\r\n## 🛠 Requirements\r\n\r\n- **PostgreSQL client (pg_dump)** must be installed:\r\n\r\n ```bash\r\n pg_dump --version\r\n ```\r\n\r\n- **S3 configuration** must be set up as described in [Medusa documentation](https://docs.medusajs.com/resources/architectural-modules/file/s3#content).\r\n\r\nExample S3 config in `medusa.config.ts`:\r\n\r\n```ts\r\nmodule.exports = defineConfig({\r\n modules: [\r\n {\r\n resolve: \"@medusajs/medusa/file\",\r\n options: {\r\n providers: [\r\n {\r\n resolve: \"@medusajs/medusa/file-s3\",\r\n id: \"s3\",\r\n options: {\r\n file_url: process.env.S3_FILE_URL,\r\n access_key_id: process.env.S3_ACCESS_KEY_ID,\r\n secret_access_key: process.env.S3_SECRET_ACCESS_KEY,\r\n region: process.env.S3_REGION,\r\n bucket: process.env.S3_BUCKET,\r\n endpoint: process.env.S3_ENDPOINT,\r\n prefix: \"resources/\",\r\n },\r\n },\r\n ],\r\n },\r\n },\r\n ],\r\n})\r\n```\r\n\r\n---\r\n\r\n## 🔄 Automatic Backups\r\n\r\nEnable automatic backups in `.env`:\r\n\r\n```dotenv\r\nDB_BACKUP_AUTO=true\r\n```\r\n\r\nDefault schedule: **daily at 1 AM**.\r\nCustomize with CRON:\r\n\r\n```dotenv\r\nDB_BACKUP_SCHEDULE=\"0 1 * * *\"\r\n```\r\n\r\nFor more details, see [crontab.guru](https://crontab.guru/).\r\n⚠️ Automatic backups run **only in production**.\r\n\r\n## 📝 Notes\r\n\r\n- Backups are compressed (\\~70% smaller size).\r\n- Backup failures are now handled gracefully with rollback support.\r\n- PostgreSQL version should match your installed `pg_dump` and `psql` tools.\r\n- Safe to restore production backups into local environments for testing.\r\n\r\n---\r\n\r\n## 📜 Changelog\r\n\r\n### v2.10.x+\r\n\r\n- Added compatibility with Medusa v2.10+\r\n- Introduced rollback mechanism for failed backups\r\n- Optimized performance of backup creation\r\n\r\n---\r\n\r\n## 🙏 Credits\r\n\r\nForked from [AmeerRizvi/medusa-backup](https://github.com/AmeerRizvi/medusa-backup).\r\nBig thanks to the original author for building the foundation of this plugin.\r\n\r\n---\r\n","readmeFilename":"README.md"}