generator-jhipster-database-backup

generator-jhipster-database-backup

[JHipster module] The purpose of this module is to perform periodic backups of your database. This backup docker image currently supports MYSQL, POSTGRESQL, MONGODB and MARIADB.

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. The purpose of this module is to perform periodic backups of your database. This backup docker image currently supports MYSQL, POSTGRESQL, MONGODB and MARIADB. The results will be .sql or .targz saves in a backup directory.

Prerequisites

As this is a JHipster module, we expect you have JHipster and its related tools already installed:

• Installing JHipster
• Installing Docker
• Installing Docker-compose

Installation

With Yarn

To install this module:

yarn global add generator-jhipster-database-backup

To update this module:

yarn global upgrade generator-jhipster-database-backup

With NPM

To install this module:

npm install -g generator-jhipster-database-backup

To update this module:

npm update -g generator-jhipster-database-backup

Usage

First, you have to run the generator using the following command :

yo jhipster-database-backup

Then enter the required parameter (backup frequency), don't forget the whitespace if you are using CRON (https://en.wikipedia.org/wiki/Cron).

Now a 'backup-database-name.yml' file has been created in the following folder : src/main/docker

This service will periodically backup your database.

Then start your database Your database should be initialized and started in a docker image using the 'database-name.yml' file located in 'src/main/docker'.

sudo docker-compose -f <database-name>.yml up

If the database failed to start, you should check if the port is free (for example 'sudo service mysql stop' to stop the default mysql service).

Finally, start the backup service :

sudo docker-compose -f backup-<database-name>.yml up

You will find your backups in the backup folder located in : src/main/docker

MYSQL

To find more details about the docker image and the parameters click here.

POSTGRESQL

To find more details about the docker image and the parameters click here.

MONGODB

Your database must not be empty ! To find more details about the docker image and the parameters click here.

MARIADB

To find more details about the docker image and the parameters click here.

License

MIT © Contribution JHipster UGA Julien COURTIAL, Hugo GROS-DAILLON, Cédric LAFRASSE et Bastien TERRIER Our contribution uses the open source work of Avi Deitcher and tutumcloud.

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.