Skip to content
This repository has been archived by the owner on Aug 9, 2024. It is now read-only.

dandanthedev/DockGuard

Repository files navigation

⚠️ This project is in very early development stage! I'm still actively working on adding more services & backup storages!

DockGuard

The easiest way to backup your Docker containers.

???

Are you struggling with backing something up, a database, container, or whatever? DockGuard is here for you! Simply run the command, enter in some basic data and get a neat export file for any kind of service! Accidentially deleted the entire database? :) Don't worry, DockGuard can get it back with just a few clicks, or, well, keyboard presses i guess... Uhh, moving on!

Support

This is the full list of containers DockGuard currently supports:

  • MySQL database

if you know anything at all about coding, please add new container types to the engines! I'll whip up some documentation soon, for now you can just check the existing files.

Usage

You can go the fully guided route by running npx dockguard and following the prompts, or you can fully automate the process by adding environment variables.

Fully Guided

Backing up

npx dockguard

Restoring

npx dockguard --restore [containername]

Environment Variables (Currently backing up only, restoring is not supported yet)

export CONTAINERNAME_USER=yourusername
export CONTAINERNAME_PASSWORD=yourpassword

npx dockguard --unattended

Supported Environment Variables & Flags

Environment Variables

  • CONTAINERNAME_USER - The username of the database running in docker container 'containername'

  • CONTAINERNAME_PASSWORD - The password of the database running in docker container 'containername'

  • DOCKGUARD_DISABLE_AUTH - Set to true to automatically temporarily disable authentication for the database running in docker container 'containername' (DANGEROUS FOR PRODUCTION)

Flags

  • --unattended - Run DockGuard without any prompts
  • --verbose - Show verbose output
  • --restore [CONTAINERNAME] Restore from backup

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published