{"id":16540701,"url":"https://github.com/osixia/docker-backup-manager","last_synced_at":"2025-06-12T23:36:16.799Z","repository":{"id":35974268,"uuid":"40265490","full_name":"osixia/docker-backup-manager","owner":"osixia","description":"A docker image to run periodically backup-manager 🐳","archived":false,"fork":false,"pushed_at":"2021-06-11T11:15:51.000Z","size":71,"stargazers_count":23,"open_issues_count":1,"forks_count":11,"subscribers_count":4,"default_branch":"stable","last_synced_at":"2025-05-31T05:18:48.614Z","etag":null,"topics":["backup-manager","docker-image"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osixia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-05T19:44:08.000Z","updated_at":"2021-11-19T14:31:20.000Z","dependencies_parsed_at":"2022-09-12T03:10:35.628Z","dependency_job_id":null,"html_url":"https://github.com/osixia/docker-backup-manager","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/osixia/docker-backup-manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-backup-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-backup-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-backup-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-backup-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osixia","download_url":"https://codeload.github.com/osixia/docker-backup-manager/tar.gz/refs/heads/stable","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-backup-manager/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259550243,"owners_count":22875243,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup-manager","docker-image"],"created_at":"2024-10-11T18:53:07.249Z","updated_at":"2025-06-12T23:36:16.775Z","avatar_url":"https://github.com/osixia.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# osixia/backup-manager\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/osixia/backup-manager.svg)][hub]\n[![Docker Stars](https://img.shields.io/docker/stars/osixia/backup-manager.svg)][hub]\n[![](https://images.microbadger.com/badges/image/osixia/backup-manager.svg)](http://microbadger.com/images/osixia/backup-manager \"Get your own image badge on microbadger.com\")\n\n[hub]: https://hub.docker.com/r/osixia/backup-manager/\n\nLatest release: 0.3.0 - Backup Manager 0.7.12.4 - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/backup-manager/) \n\n**A docker image to run periodically backup-manager.**\n\u003e https://github.com/sukria/Backup-Manager\n\n- [Quick start](#quick-start)\n- [Beginner Guide](#beginner-guide)\n\t- [Backup directory and data persistence](#backup-directory-and-data-persistence)\n\t- [Use your own Backup Manager config](#use-your-own-backup-manager-config)\n\t- [Fix docker mounted file problems](#fix-docker-mounted-file-problems)\n\t- [Debug](#debug)\n- [Environment Variables](#environment-variables)\n\t- [Set your own environment variables](#set-your-own-environment-variables)\n\t\t- [Use command line argument](#use-command-line-argument)\n\t\t- [Link environment file](#link-environment-file)\n\t\t- [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)\n- [Advanced User Guide](#advanced-user-guide)\n\t- [Extend osixia/backup-manager:0.3.0 image](#extend-osixiabackup-manager030-image)\n\t- [Make your own backup-manager image](#make-your-own-backup-manager-image)\n\t- [Tests](#tests)\n\t- [Under the hood: osixia/light-baseimage](#under-the-hood-osixialight-baseimage)\n- [Security](#security)\n- [Changelog](#changelog)\n\n## Quick start\n\n    # Run Backup Manager image\n    docker run --volume /host/data:/data-to-backup --detach osixia/backup-manager:0.3.0\n\n## Beginner Guide\n\n### Backup directory and data persistence\n\nBackups are created by default in the directory `/data/backup` that has been declared as a volume, so your backup files are saved outside the container in a data volume.\n\nFor more information about docker data volume, please refer to :\n\n\u003e [https://docs.docker.com/userguide/dockervolumes/](https://docs.docker.com/userguide/dockervolumes/)\n\n\n### Use your own Backup Manager config\nThis image comes with a backup manager config file that can be easily customized via environment variables for a quick bootstrap,\nbut setting your own backup-manager.conf is possible. 2 options:\n\n- Link your config file at run time to `/container/service/backup-manager/assets/backup-manager.conf` :\n\n      docker run --volume /data/my-backup-manager.conf:/container/service/backup-manager/assets/backup-manager.conf --detach osixia/backup-manager:0.3.0\n\n- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide](#advanced-user-guide)\n\n### Fix docker mounted file problems\n\nYou may have some problems with mounted files on some systems. The startup script try to make some file adjustment and fix files owner and permissions, this can result in multiple errors. See [Docker documentation](https://docs.docker.com/v1.4/userguide/dockervolumes/#mount-a-host-file-as-a-data-volume).\n\nTo fix that run the container with `--copy-service` argument :\n\n\t\tdocker run [your options] osixia/backup-manager:0.3.0 --copy-service\n\n### Debug\n\nThe container default log level is **info**.\nAvailable levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.\n\nExample command to run the container in `debug` mode:\n\n\tdocker run --detach osixia/backup-manager:0.3.0 --loglevel debug\n\nSee all command line options:\n\n\tdocker run osixia/backup-manager:0.3.0 --help\n\n## Environment Variables\n\nEnvironment variables defaults are set in **image/environment/default.yaml**\n\nSee how to [set your own environment variables](#set-your-own-environment-variables)\n\n- **BACKUP_MANAGER_ARCHIVE_METHOD**: Archive method, this image allows you to set **tarball** or **tarball-incremental** methods with the following environment variables but all Backup Manager environment variables (starting by *BM_**) can also be set to configure any method you need. Defaults to `tarball`.\n\n- **BACKUP_MANAGER_TARBALL_DIRECTORIES**: Directories to backup: paths without spaces in their name. Defaults to `/data-to-backup /data-to-backup2`.\n\n- **BACKUP_MANAGER_CRON_EXP**: Cron expression to schedule backup-manager execution. Defaults to `0 4 * * *`. Every days at 4am.\n\n- **BACKUP_MANAGER_TTL**: Backup TTL in days. Defaults to `15`.\n\nUpload configuration:\n\n- **BACKUP_MANAGER_UPLOAD_METHOD**: Upload method. Defaults to `ftp`.\n\n- **BACKUP_MANAGER_UPLOAD_HOSTS**: Upload to this ftp hosts. Defaults to `ftp.example.org`.\n\n- **BACKUP_MANAGER_UPLOAD_FTP_USER**: Ftp user. Defaults to `ftp-user`.\n- **BACKUP_MANAGER_UPLOAD_FTP_PASSWORD**: Ftp password. Defaults to `ftp-password`.\n- **BACKUP_MANAGER_UPLOAD_DESTINATION**: Upload to this ftp directory.  Defaults to `/`.\n- **BACKUP_MANAGER_UPLOAD_TTL**: Backup TTL on the ftp hosts in days. Defaults to `60`.\n\nEncryption configuration:\n\n- **BACKUP_MANAGER_ENCRYPTION**: Encrypt backups. Defaults to `false`.\n- **BACKUP_MANAGER_ENCRYPTION_RECIPIENT**: GPG recipient. Defaults to `Mike Ross`.\n\nIncremental tarball configuration:\n- **BACKUP_MANAGER_TARBALLINC_MASTERDATETYPE**: Which frequency to use for the master tarball? possible values: weekly, monthly. Defaults to `weekly`.\n\n- **BACKUP_MANAGER_TARBALLINC_MASTERDATEVALUE**: Number of the day, in the BACKUP_MANAGER_TARBALLINC_MASTERDATETYPE frequency when master tarballs should be made. Defaults to `1`.\n\n\tExamples: you want to make master tarballs every friday:\n\tBACKUP_MANAGER_TARBALLINC_MASTERDATETYPE=\"weekly\"\n\tBACKUP_MANAGER_TARBALLINC_MASTERDATEVALUE=\"5\"\n\n\tOr every first day of the month:\n\tBACKUP_MANAGER_TARBALLINC_MASTERDATETYPE=\"monthly\"\n\tBACKUP_MANAGER_TARBALLINC_MASTERDATEVALUE=\"1\"\n\nPipe configuration:\n- **BACKUP_MANAGER_PIPE_COMMAND_0**: Command\n- **BACKUP_MANAGER_PIPE_NAME_0**: Name of command (no mandatory, empty if not set)\n- **BACKUP_MANAGER_PIPE_FILETYPE_0**: File type of pipe command (no mandatory, empty if not set)\n- **BACKUP_MANAGER_PIPE_COMPRESS_0**: Compress type (no mandatory, empty if not set)\n\nYou can add **BACKUP_MANAGER_PIPE_COMMAND_1**, **BACKUP_MANAGER_PIPE_COMMAND_2**... to implement other pipe command.\n\n    Examples: Archive a remote MySQL database through SSH:\n    BACKUP_MANAGER_PIPE_COMMAND_0: ssh host -c \\\\\"mysqldump -ufoo -pbar base\\\\\"\n    BACKUP_MANAGER_PIPE_NAME_0: base\n    BACKUP_MANAGER_PIPE_FILETYPE_0: sql\n    BACKUP_MANAGER_PIPE_COMPRESS_0: gzip\n    Archive a specific directory, on a remote server through SSH:\n    BACKUP_MANAGER_PIPE_COMMAND_1: ssh host -c \\\\\"tar -c -z /home/user\\\\\"\n    BACKUP_MANAGER_PIPE_NAME_1: host.home.user\n    BACKUP_MANAGER_PIPE_FILETYPE_1: tar.gz\n\nMore help: https://raw.githubusercontent.com/sukria/Backup-Manager/master/doc/user-guide.txt\n\n### Set your own environment variables\n\n#### Use command line argument\nEnvironment variables can be set by adding the --env argument in the command line, for example:\n\n\tdocker run --env BACKUP_MANAGER_TARBALL_DIRECTORIES=\"/home/billy\" \\\n\t--detach osixia/backup-manager:0.3.0\n\n#### Link environment file\n\nFor example if your environment file is in :  /data/backup-manager/environment/my-env.yaml\n\n\tdocker run --volume /data/backup-manager/environment/my-env.yaml:/container/environment/01-custom/env.yaml \\\n\t--detach osixia/backup-manager:0.3.0\n\nTake care to link your environment file to `/container/environment/XX-somedir` (with XX \u003c 99 so they will be processed before default environment files) and not  directly to `/container/environment` because this directory contains predefined baseimage environment files to fix container environment (INITRD, LANG, LANGUAGE and LC_CTYPE).\n\n#### Make your own image or extend this image\n\nThis is the best solution if you have a private registry. Please refer to the [Advanced User Guide](#advanced-user-guide) just below.\n\n## Advanced User Guide\n\n### Extend osixia/backup-manager:0.3.0 image\n\nIf you need to add your custom TLS certificate, bootstrap config or environment files the easiest way is to extends this image.\n\nDockerfile example:\n\n    FROM osixia/backup-manager:0.3.0\n    MAINTAINER Your Name \u003cyour@name.com\u003e\n\n    ADD environment /container/environment/01-custom\n    ADD gpg-keys /container/service/gpg/assets\n    ADD my-backup-manager.conf /container/service/backup-manager/assets/backup-manager.conf\n\n\n### Make your own backup-manager image\n\nClone this project :\n\n\tgit clone https://github.com/osixia/docker-backup-manager\n\tcd docker-backup-manager\n\nAdapt Makefile, set your image NAME and VERSION, for example :\n\n\tNAME = osixia/backup-manager\n\tVERSION = 0.2.0\n\n\tbecomes :\n\tNAME = billy-the-king/backup-manager\n\tVERSION = 0.1.0\n\nAdd your custom keys, environment files, config ...\n\nBuild your image :\n\n\tmake build\n\nRun your image :\n\n\tdocker run -d billy-the-king/backup-manager:0.1.0\n\n### Tests\n\nWe use **Bats** (Bash Automated Testing System) to test this image:\n\n\u003e [https://github.com/sstephenson/bats](https://github.com/sstephenson/bats)\n\nInstall Bats, and in this project directory run :\n\n\tmake test\n\n### Under the hood: osixia/light-baseimage\n\nThis image is based on osixia/light-baseimage.\nMore info: https://github.com/osixia/docker-light-baseimage\n\n## Security\nIf you discover a security vulnerability within this docker image, please send an email to the Osixia! team at security@osixia.net. For minor vulnerabilities feel free to add an issue here on github.\n\nPlease include as many details as possible.\n\n## Changelog\n\nPlease refer to: [CHANGELOG.md](CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosixia%2Fdocker-backup-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosixia%2Fdocker-backup-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosixia%2Fdocker-backup-manager/lists"}