{"id":18289895,"url":"https://github.com/tiredofit/docker-backuppc","last_synced_at":"2025-06-10T12:39:55.993Z","repository":{"id":56814812,"uuid":"101132883","full_name":"tiredofit/docker-backuppc","owner":"tiredofit","description":"Docker web based enterprise backup software","archived":false,"fork":false,"pushed_at":"2024-05-24T17:07:38.000Z","size":120,"stargazers_count":29,"open_issues_count":8,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-05T09:34:51.098Z","etag":null,"topics":["backuppc","docker","zabbix-agent"],"latest_commit_sha":null,"homepage":"","language":"Perl","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/tiredofit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["tiredofit"]}},"created_at":"2017-08-23T03:20:02.000Z","updated_at":"2025-03-28T11:44:43.000Z","dependencies_parsed_at":"2025-04-05T09:41:56.395Z","dependency_job_id":null,"html_url":"https://github.com/tiredofit/docker-backuppc","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-backuppc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-backuppc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-backuppc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-backuppc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiredofit","download_url":"https://codeload.github.com/tiredofit/docker-backuppc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-backuppc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259078308,"owners_count":22802099,"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":["backuppc","docker","zabbix-agent"],"created_at":"2024-11-05T14:08:42.732Z","updated_at":"2025-06-10T12:39:55.948Z","avatar_url":"https://github.com/tiredofit.png","language":"Perl","funding_links":["https://github.com/sponsors/tiredofit","https://www.paypal.me/tiredofit"],"categories":[],"sub_categories":[],"readme":"# github.com/tiredofit/docker-backuppc\n\n[![GitHub release](https://img.shields.io/github/v/tag/tiredofit/docker-backuppc?style=flat-square)](https://github.com/tiredofit/docker-backuppc/releases/latest)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/tiredofit/docker-backuppc/main.yml?branch=main\u0026style=flat-square)](https://github.com/tiredofit/docker-backuppc/actions)\n[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/backuppc.svg?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/tiredofit/backuppc/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/backuppc.svg?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/tiredofit/backuppc/)\n[![Become a sponsor](https://img.shields.io/badge/sponsor-tiredofit-181717.svg?logo=github\u0026style=flat-square)](https://github.com/sponsors/tiredofit)\n[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal\u0026style=flat-square)](https://www.paypal.me/tiredofit)\n\n* * *\n\n## About\nThis will build a Docker image for [BackupPC](https://backuppc.github.io/backuppc/) - A highly performant backup system.\n\n## Maintainer\n- [Dave Conroy](https://github.com/tiredofit)\n\n# Table of Contents\n\n- [Configuration](#configuration)\n  - [Data-Volumes](#data-volumes)\n  - [Environment Variables](#environment-variables)\n- [Networking](#networking)\n- [Maintenance](#maintenance)\n  - [Shell Access](#shell-access)\n\n## Prerequisites and Assumptions\n-  Assumes you are using some sort of SSL terminating reverse proxy such as:\n   -  [Traefik](https://github.com/tiredofit/docker-traefik)\n   -  [Nginx](https://github.com/jc21/nginx-proxy-manager)\n   -  [Caddy](https://github.com/caddyserver/caddy)\n- Make sure there is adequate storage available to perform deduplicated backups!\n\n\n## Installation\n\n### Build from Source\nClone this repository and build the image with `docker build -t (imagename) .`\n\n### Prebuilt Images\nBuilds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/backuppc)\n\n```bash\ndocker pull docker.io/tiredofit/backuppc:(imagetag)\n```\n\nBuilds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-backuppc/pkgs/container/docker-backuppc) \n \n```\ndocker pull ghcr.io/tiredofit/docker-backuppc:(imagetag)\n``` \n\nThe following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):\n\n| Container OS | Tag       |\n| ------------ | --------- |\n| Alpine       | `:latest` |\n\n## Configuration\n\n\n### Quick Start\n\n- The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [docker-compose.yml](examples/docker-compose.yml) that can be modified for development or production use.\n\n- Set various [environment variables](#environment-variables) to understand the capabilities of this image.\n- Map [persistent storage](#data-volumes) for access to configuration and data files for backup.\n- Enter inside the container and as user `backuppc` `ssh-copy-id` your public keys to a remote host\n- Visit your Web interface\n\n### Persistent Storage\n\nThe following directories are used for configuration and can be mapped for persistent storage.\n\n| Directory           | Description                            |\n| ------------------- | -------------------------------------- |\n| `/etc/backuppc`     | Configuration Files                    |\n| `/home/backuppc`    | Home Directory for Backuppc (SSH Keys) |\n| `/var/lib/backuppc` | The backed up Data                     |\n| `/www/logs`         | Logfiles for Nginx, BackupPC           |\n\n### Environment Variables\n\n#### Base Images used\n\nThis image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) or [Debian Linux](https://hub.docker.com/r/tiredofit/debian) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`, `nano`.\n\nBe sure to view the following repositories to understand all the customizable options:\n\n| Image                                                  | Description                            |\n| ------------------------------------------------------ | -------------------------------------- |\n| [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux |\n| [Nginx](https://github.com/tiredofit/docker-nginx/)    | Nginx webserver                        |\n\n#### Container Options\n\n| Variable         | Description                   | Default                |\n| ---------------- | ----------------------------- | ---------------------- |\n| `USER_BACKUPPC`  | The uid for the backuppc user | `1000`                 |\n| `GROUP_BACKUPPC` | The gid for the backuppc user | `1000`                 |\n| `CONFIG_PATH`    | BackupPC Configuration Files  | `/etc/backuppc`        |\n| `DATA_PATH`      | BackupPC data backups         | `/var/lib/backuppc`    |\n| `LOG_PATH`       | Logfiles for BackupPC         | `/www/logs/backuppc`   |\n| `SSH_KEYS_PATH`  | SSH Keys Path                 | `/home/.backuppc/.ssh` |\n\n\n#### Authentication\n\nBy default, this image does not use authentication. This is definitely not recommended on a production environment! Based on the environment variables from the [Nginx Base Image](https://github.com/tiredofit/docker-nginx/) you can set them here:\n\nIt's highly recommend you set at minimum:\n\n```bash\nNGINX_AUTHENTICATION_TYPE=BASIC\nNGINX_AUTHENTICATION_BASIC_USER1=backuppc\nNGINX_AUTHENTICATION_BASIC_PASS1=backuppc\n```\n\n| Parameter                                   | Description                                                                    | Default        |\n| ------------------------------------------- | ------------------------------------------------------------------------------ | -------------- |\n| `NGINX_AUTHENTICATION_TYPE`                 | Protect the site with `BASIC`, `LDAP`, `LLNG`                                  | `NONE`         |\n| `NGINX_AUTHENTICATION_TITLE`                | Challenge response when visiting protected site                                | `Please login` |\n| `NGINX_AUTHENTICATION_BASIC_USER1`          | If `BASIC` chosen enter this for the username to protect site                  | `admin`        |\n| `NGINX_AUTHENTICATION_BASIC_PASS1`          | If `BASIC` chosen enter this for the password to protect site                  | `password`     |\n| `NGINX_AUTHENTICATION_BASIC_USER2`          | As above, increment for more users                                             |                |\n| `NGINX_AUTHENTICATION_BASIC_PASS2`          | As above, increment for more users                                             |                |\n| `NGINX_AUTHENTICATION_LDAP_HOST`            | Hostname and port number of LDAP Server - ie `ldap://ldapserver:389`           |                |\n| `NGINX_AUTHENTICATION_LDAP_BIND_DN`         | User to Bind to LDAP - ie `cn=admin,dc=orgname,dc=org`                         |                |\n| `NGINX_AUTHENTICATION_LDAP_BIND_PW`         | Password for Above Bind User - ie `password`                                   |                |\n| `NGINX_AUTHENTICATION_LDAP_BASE_DN`         | Base Distringuished Name - eg `dc=hostname,dc=com`                             |                |\n| `NGINX_AUTHENTICATION_LDAP_ATTRIBUTE`       | Unique Identifier Attrbiute -ie `uid`                                          |                |\n| `NGINX_AUTHENTICATION_LDAP_SCOPE`           | LDAP Scope for searching - ie `sub`                                            |                |\n| `NGINX_AUTHENTICATION_LDAP_FILTER`          | Define what object that is searched for (ie `objectClass=person`)              |                |\n| `NGINX_AUTHENTICATION_LDAP_GROUP_ATTRIBUTE` | If searching inside of a group what is the Group Attribute - ie `uniquemember` |                |\n| `NGINX_AUTHENTICATION_LLNG_HANDLER_HOST`    | If `LLNG` chosen use hostname of handler                                       | `llng-handler` |\n| `NGINX_AUTHENTICATION_LLNG_HANDLER_PORT`    | If `LLNG` chosen use this port for handler                                     | `2884`         |\n| `NGINX_AUTHENTICATION_LLNG_ATTRIBUTE1`      | Syntax: HEADER_NAME, Variable, Upstream Variable - See note below              |                |\n| `NGINX_AUTHENTICATION_LLNG_ATTRIBUTE2`      | Syntax: HEADER_NAME, Variable, Upstream Variable - See note below              |                |\n\nWhen working with `NGINX_AUTHENTICATION_LLNG_ATTRIBUTE2` you will need to omit any `$` chracters from your string. It will be added in upon container startup. Example:\n`NGINX_AUTHENTICATION_LLNG_ATTRIBUTE1=HTTP_AUTH_USER,uid,upstream_http_uid` will get converted into `HTTP_AUTH_USER,$uid,$upstream_http_uid` and get placed in the appropriate areas in the configuration.\n* * *\n\n#### SMTP Options\n\nSee the [MSMTP Configuration Options](https://marlam.de/msmtp/msmtp.html) for further information on options to configure MSMTP.\n\n| Parameter             | Description                                       | Default         |\n| --------------------- | ------------------------------------------------- | --------------- |\n| `SMTP_AUTO_FROM`      | Add setting to support sending through Gmail SMTP | `FALSE`         |\n| `SMTP_HOST`           | Hostname of SMTP Server                           | `postfix-relay` |\n| `SMTP_PORT`           | Port of SMTP Server                               | `25`            |\n| `SMTP_DOMAIN`         | HELO Domain                                       | `docker`        |\n| `SMTP_MAILDOMAIN`     | Mail Domain From                                  | `local`         |\n| `SMTP_AUTHENTICATION` | SMTP Authentication                               | `none`          |\n| `SMTP_USER`           | SMTP Username                                     | ``              |\n| `SMTP_PASS`           | SMTP Password                                     | ``              |\n| `SMTP_TLS`            | Use TLS                                           | `FALSE`         |\n| `SMTP_STARTTLS`       | Start TLS from within session                     | `FALSE`         |\n| `SMTP_TLSCERTCHECK`   | Check remote certificate                          | `FALSE`         |\n\n### Networking\n\nThe following ports are exposed and available to public interfaces\n\n| Port | Description |\n| ---- | ----------- |\n| `80` | HTTP        |\n\n**NOTE**: It is highly recommended this be run through a SSL proxy, or via localhost and tunnel via SSH.\n\n## Maintenance\n\n### Shell Access\n\nFor debugging and maintenance purposes you may want access the containers shell.\n\n````bash\ndocker exec -it (whatever your container name is) bash\n````\n\n## Support\n\nThese images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.\n\n### Usage\n- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.\n- [Sponsor me](https://tiredofit.ca/sponsor) for personalized support\n\n### Bugfixes\n- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.\n\n### Feature Requests\n- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.\n- [Sponsor me](https://tiredofit.ca/sponsor) regarding development of features.\n\n### Updates\n- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.\n- [Sponsor me](https://tiredofit.ca/sponsor) for up to date releases.\n\n## License\nMIT. See [LICENSE](LICENSE) for more details.\n\n# References\n\n- http://backuppc.sourceforge.net/\n- https://backuppc.github.io/backuppc/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-backuppc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiredofit%2Fdocker-backuppc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-backuppc/lists"}