gmentsik/docktartar repository overview

⁠DockTartar

• Introduction⁠
• Getting started⁠
  • Installation⁠
  • Quickstart⁠
  • Environment Variables⁠
• Maintenance⁠
  • Upgrading⁠
  • Shell Access⁠
• Change history⁠
• Contributing⁠
• Issues⁠

⁠Introduction

Docktartar will recursively tar a directory to another location. It has been designed to stop running docker containers before doing the backup and restart them after the archival process.

Some Features:

• Multi-Core Compression with pigz
• CRON daemon to schedule the backup job
• SMB Client to backup to a network share
• Temp-Directory to build the archive locally (eg SSD), restart the containers and move the archive afterwards
• Mail notifications with ssmtp
• Full configuration with environment variables
• Chose which containers to stop and restart

You can provide a temp-directory for faster archival, afterwards the script will move the archive wherever you want. This is useful in cases where you want to store your backup on a remote server (you should really do this!). The workflow in this case is:

1. Stop Containers
2. Build the archive in the /backupTmp directory
3. Start containers
4. move the archive from /backupTmp to /targetTmp
5. Chown the archive

⁠Getting started

⁠Installation

Automated builds of the image are available on Dockerhub⁠ and is the recommended method of installation.

docker pull gmentsik/docktartar

Alternatively you can build the image yourself.

docker build -t gmentsik/docktartar github.com/gmentsik/docktartar

⁠Quickstart

You can use the sample docker-compose.yml⁠ file to start the container using Docker Compose⁠*

Or start Docktartar using:

docker run -d --name docktartar \
              --restart=always \
              --volume /srv/docker:/backupSource \
              --volume /var/backups/docker:/backupTarget  \
              --volume /var/run/docker.sock:/var/run/docker.sock \
              --volume /var/lib/docker:/var/lib/docker \
      gmentsik/docktartar

⁠Environment Variables

⁠Samba Share and Permissions

In order to run this with samba share as the backup target, you have to either run the container with privileged: true or add cap_add: SYS_ADMIN

⁠Volumes

⁠Maintenance

⁠Test Mail settings

There is a test script in the root folder called test-mail.sh which can be used to test the email settings.

docker exec -it docktartar /root/test-mail.sh

⁠Upgrading

To upgrade to newer releases:

1. Download the updated Docker image:

docker pull gmentsik/docktartar

1. Stop the currently running image:

docker stop docktartar

1. Remove the stopped container

docker rm -v docktartar

1. Start the updated image

docker run -name docktartar -d [OPTIONS] gmentsik/docktartar

⁠Shell Access

For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version 1.3.0 or higher you can access a running containers shell by starting bash using docker exec:

docker exec -it docktartar bash

⁠Contributing

If you find this image useful here's how you can help:

• Send a pull request with your awesome features and bug fixes
• Help users resolve their issues⁠.

⁠Issues

Before reporting your issue please try updating Docker to the latest version and check if it resolves the issue. Refer to the Docker installation guide⁠ for instructions.

SELinux users should try disabling SELinux using the command setenforce 0 to see if it resolves the issue.

If the above recommendations do not help then report your issue⁠ along with the following information:

• Output of the docker version and docker info commands
• The docker run command or docker-compose.yml used to start the image. Mask out the sensitive bits.
• Please state if you are using Boot2Docker⁠, VirtualBox⁠, etc.