djbackup 2.0.0

dj_backup is an installable module for Django that is used for backup purposes.

dj_backup

What is this ?

DJ Backup is a Django app that provides the capability to back up your files and databases.

supported databases

• mysql
• postgres
• sqlite

supported storages

• local
• sftp server
• ftp server
• dropbox(beta)
• telegram bot

How to use ?

1. First you need to install dj_backup

    pip install djbackup

2. After that, add the dj_backup and django_q apps to your Django project's installed apps.

    INSTALLED_APPS = [
    ...
    ...
    # apps
    'dj_backup',
    'django_q'
]

3. add static files dir path to django

STATICFILES_DIRS = (
    ...
    os.path.join(BASE_DIR, 'dj_backup/static/'),
)

4. add locale file to django(optional)

LOCALE_PATHS = (
    ...
    BASE_DIR/ 'dj_backup/locale',
)

5. add dj_backup urls to project urls

urlpatterns = [
    ...
    path('dj-backup/', include('dj_backup.urls', namespace='dj_backup')),
    ...
]

6. set dj_backup config to django settings

    DJ_BACKUP_CONFIG = {
    # optional (if dj_backup cant find `pg_dump` file then you must fill this
    'POSTGRESQL_DUMP_PATH': None,
    # optional (if dj_backup cant find `mysqldump` file then you must fill this
    'MYSQL_DUMP_PATH': None,
    # if you want backup external databases you can set this config
    # By default local databases are accessible and can be backed up
    'EXTERNAL_DATABASES': {
        # 'external_db': {
        #     'ENGINE': 'mysql',
        #     'NAME': 'test',
        #     'USER': 'test',
        #     'PASSWORD': 'test',
        #     'HOST': '127.0.0.1',  # Or an IP Address that your DB is hosted on
        #     'PORT': 3306  # optional
        # },
        ...
        ...
    },
    'BASE_ROOT_DIRS': [
        # the main path for the files that need to be backed up
        BASE_DIR,
        ...
    ],
    'BACKUP_TEMP_DIR': BASE_DIR / 'backup/temp',
    'STORAGES': {
        'LOCAL': {
            'OUT': BASE_DIR / 'backup/result'  # the path local storage
        },
        'SFTP_SERVER': {
            'HOST': 'xxx.xxx.xxx.xxx',
            'USERNAME': 'xxx.xxx.xxx.xxx',
            'PASSWORD': 'xxx.xxx.xxx.xxx',
            'OUT': '/backups'
        },
        'FTP_SERVER': {
            'HOST': "xxx.xxx.xxx.xxx",
            'USERNAME': "xxx.xxx.xxx.xxx",
            'PASSWORD': "xxx.xxx.xxx.xxx",
            'OUT': '/backups'
        },
        'DROPBOX': {
            'ACCESS_TOKEN': 'xxx.xxx.xxx.xxx',
            'OUT': '/backups'
        },
        'TELEGRAM_BOT': {
             'BOT_TOKEN': 'xxx',
             'CHAT_ID': 'xxx'
         }
    }
}

7. migrate & collect static files

    python manage.py migrate

    python manage.py collectstatic

8. run backup!

    python manage.py run-backup

9. Dashboard

now you can access to dj_backup dashboard

    127.0.0.1:8000/dj-backup/

OR

    xxx.xxx:xxxx/dj-backup/  

NOTE:

If you dont need any of the storages, you must remove that configuration
because you get an error if it cant be connected