Skip to main content

Django app to backup Sqlite or Postgres database to an S3 Object Storage.

Project description

Telescoop Backup

Backup your sqlite database to an S3 compatible provider.

Quick start

Configuration

  • Add "Telescop Backup" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = [
    ...
    'telescoop_backup',
]
  • Include the Telescop Backup URLconf in your project urls.py like this::
    path('backup/', include('telescoop_backup.urls')),
  • Define the following settings in settings.py
BACKUP_ACCESS = 'my_access'  # S3 ACCESS
BACKUP_SECRET = 'my_secret'  # S3 SECRET KEY
BACKUP_BUCKET = 'my_project_backup'  # S3 Bucket
BACKUP_KEEP_N_DAYS = 31  # Optional, defaults to 31
BACKUP_HOST = None  # Optional, default to s3.fr-par.scw.cloud (Scaleway Storage in Paris)

# Optional, for compressing the backup
BACKUP_COMPRESS = True
BACKUP_RECOVER_N_WORKERS = 4  # Optional, default to 1

By default, old backups are removed in order not to take up too much space. If you don't want them removed, just set a very large value for BACKUP_KEEP_N_DAYS.

Backup

You can now backup with the backup_db management command :

  • python manage.py backup_db backup to back up current database
  • python manage.py backup_db media to back up settings.MEDIA_ROOT
  • python manage.py backup_db list to list previous backups
  • python manage.py backup_db recover [file_name] to recover previous database

View last backup and if it is recent

  • /backup/last-backup shows the latest backup
  • /backup/backup-is-less-than-XX-hours-old answers yes (status 200) or no (status 500). This route can be used with a service such as uptimerobot.com.

Gitignore

If you use it in local environment, ignore the backup files

.telescoop_backup_last_backup
*.sqlite

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telescoop_backup-0.3.3.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telescoop_backup-0.3.3-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file telescoop_backup-0.3.3.tar.gz.

File metadata

  • Download URL: telescoop_backup-0.3.3.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for telescoop_backup-0.3.3.tar.gz
Algorithm Hash digest
SHA256 363bea44f8f8a8222e4cc867945b2080a1bd1690cd44883c2d3ff39493bc0a87
MD5 6027f56537e5a17913f01e678e173419
BLAKE2b-256 a0a7efbf1d15ec5b193d097640e2ede252ab0c955cbd8a1f45525832325a5a55

See more details on using hashes here.

File details

Details for the file telescoop_backup-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for telescoop_backup-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1b017f1cfd1af3ef66afadff54a46eac93ed0fcb32409d58bdb1f7e262b5e04a
MD5 57861543bd8b5606be07f0f13342d6a6
BLAKE2b-256 86821d075b9915e5e8f94498e226364e891cd0dc108e35b81e83d86af6c6d4bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page