Sync Remote and Local MongoDB Databases 🔥
Branch: master
Clone or download
sheharyarn Merge pull request #15 from itnok/master
Support for synchronization over SSH tunnel and optional auth credentials for both local/remote DB
Latest commit de09c94 Apr 13, 2017

README.md

mongo-sync

Sync Remote and Local MongoDB Databases in Bash. Works with Heroku too!

For all the Rubyists out there, I've converted this in to a Ruby Gem as well.

mongo-sync demo gif

Usage

  • Download / Clone the script

    git clone https://github.com/sheharyarn/mongo-sync.git
    cd mongo-sync
  • Edit config.yml and insert your configuration details

  • Use the script like this:

     ./mongo-sync push [options]		# Push DB to Remote
     ./mongo-sync pull [options]		# Pull DB to Local
  • Options

     -y  # Skip confirmation
     --config alternate-config-file.yml
    

Notes

  • mongo-sync requires mongodump and mongorestore binaries to be installed in your system. If you have mongodb installed, then you probably already have them
  • Pushing/Pulling overwrites the Target DB
  • It's a good idea to keep your config.yml in .gitignore if you're using it inside some other project

TODO

  • Add a --no-overwrite flag+feature that doesn't drop the target db before restoring it, and actually tries to sync it
  • Add a backup command and an --auto-backup feature
  • Add more options for Local DB in config.yml

Contributing

  1. Fork it
  2. Create your feature/fix branch (git checkout -b feature/my-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-feature)
  5. Create a new Pull Request

License

Copyright (c) 2015 Sheharyar Naseer

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.