domposy

domposy: Simplify your Docker Compose management - Create backups…

MIT License

Description

What is domposy?

domposy is a Linux Bash script that helps to backup and update Docker Compose containers (preferably with bind mounts). In addition, it is possible to perform a secure Docker cleanup of resources that are no longer used.

This involves searching for the Docker Compose folder, which then also contains the .yml file, the bind mounts that are important for the container itself and hopefully an .env file. 😜

This entire folder is then securely tared and then compressed. The backup is then located where you want it.

Timestamps are also used for the backups. Help is also provided on how the backups can be reused. All important information is also logged. If no container is started or a backup is created, all Docker Compose containers are automatically started afterwards.

It may be important to adjust the directories here.

Finally, it is very easy to simply backup the whole thing to a NAS that has been mounted with NFS or SMB, for example.

Only Docker Compose files named docker-compose.yml or docker-compose.yaml are used for search!

Ideally, it has the following structure:

<service-name>/
│
├── docker-compose.yml
│
├── .env
│
└── volumes/

Where the files are located is almost irrelevant. Ideally, there should be a folder containing all the services.

Examples for Docker Compose files:

Repository docker-compose-files

Who is it for?

This script is ideal for homelab enthusiasts, but also for people who work a lot with Docker Compose files.

However, I do not currently recommend using it productively in a company.

The Goal of the domposy Project

It is important to create backups. Unfortunately, it is not so easy for homelab enthusiasts in particular to do this easily and to run it as a cronjob. Again and again you have to write a script yourself, which is not so easy… To remedy this, there is exactly this. It is simply simple. It would be nice if Docker itself would provide such functionality in the future for exactly the kind of use case described above.

⚠️ Disclaimer - Important!

The whole thing is still at an early stage of development and can therefore lead to unexpected behaviour.

To be used with caution.

Getting Started

It is best to download the latest release to your target environment.

Make the script executable:

chmod +x domposy.sh

Use the script:

Usage: (sudo) ./domposy.sh [-h] [-d] [-n] [-a ACTION] [-s SEARCH_DIR] [-b BACKUP_DIR] [-e EXCLUDE_DIR] [-c]
  -h                 Show help
  -d                 Enables debug logging
  -n                 Executes a dry run, i.e. no changes are made to the file system with the exception of logging
  -a ACTION          ACTION to be performed: 'update', 'backup' or 'all' (Default: 'all')
  -s SEARCH_DIR      Directory to search for docker-compose files (Default: '/home/')
  -b BACKUP_DIR      Destination directory for backups (Default: '/tmp/domposy_backups/')
  -e EXCLUDE_DIR     Directory to exclude from search (Default: 'tmp')
  -c                 Additional docker cleanup

Example

sudo ./domposy.sh -d -a all -s . -b /tmp/test -e /tmp -c

Example with Advanced Debugging

sudo ./domposy.sh > /tmp/debug-log_domposy.txt

If you think this tool is useful and saves you a lot of work and nerves and lets you sleep better, then a small donation would be very nice.

Paypal

This might also interest you

esase: Easy Setup And System Enhancement (Popup based Linux Bash script/tool)

This site is open source. Improve this page.