README.md

Introduction

Easily backup (database and assets) your Masonite apps

Features

• Database (PostgreSQL, SQLite, MySQL) backup
• Assets backup
• Backup upload to defined storage (local, S3...)
• Others to come...

Official Masonite Documentation

New to Masonite ? Please first read the Official Documentation. Masonite strives to have extremely comprehensive documentation 😃. It would be wise to go through the tutorials there. If you find any discrepencies or anything that doesn't make sense, be sure to comment directly on the documentation to start a discussion!

Also be sure to join the Slack channel!

Installation

pip install masonite-backups

Configuration

Add BackupsProvider to your project in config/providers.py:

# config/providers.py
# ...
from masonite.backups import BackupsProvider

# ...
PROVIDERS = [
    # ...
    # Third Party Providers
    BackupsProvider,
    # ...
]

Then install OR publish the required package files (configuration, views ...):

python craft backups:install

OR (depending on your preferences)

python craft publish BackupsProvider

Specify sources, destination, name at minimum.

Usage

To make a backup of all assets and databases defined in config file run this command:

python craft backups:run

To make a backup of databases only:

python craft backups:run --only-db

To make a backup of assets only:

python craft backups:run --only-assets

Contributing

Please read the Contributing Documentation here.

Maintainers

• Samuel Girardin

License

Masonite Backups is open-sourced software licensed under the MIT license.