This will build a Docker image for BackupPC - A highly performant backup system.
- Assumes you are using some sort of SSL terminating reverse proxy such as:
- Make sure there is adequate storage available to perform deduplicated backups!
Clone this repository and build the image with docker build -t (imagename) .
Builds of the image are available on Docker Hub
docker pull docker.io/tiredofit/backuppc:(imagetag)Builds of the image are also available on the Github Container Registry
docker pull ghcr.io/tiredofit/docker-backuppc:(imagetag)
The following image tags are available along with their tagged release based on what's written in the Changelog:
| Container OS | Tag |
|---|---|
| Alpine | :latest |
-
The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabilities of this image.
-
Map persistent storage for access to configuration and data files for backup.
-
Enter inside the container and as user
backuppcssh-copy-idyour public keys to a remote host -
Visit your Web interface
The following directories are used for configuration and can be mapped for persistent storage.
| Directory | Description |
|---|---|
/etc/backuppc |
Configuration Files |
/home/backuppc |
Home Directory for Backuppc (SSH Keys) |
/var/lib/backuppc |
The backed up Data |
/www/logs |
Logfiles for Nginx, BackupPC |
This image relies on an Alpine Linux or Debian Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate, nano.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
|---|---|
| OS Base | Customized Image based on Alpine Linux |
| Nginx | Nginx webserver |
| Variable | Description | Default |
|---|---|---|
USER_BACKUPPC |
The uid for the backuppc user | 1000 |
GROUP_BACKUPPC |
The gid for the backuppc user | 1000 |
CONFIG_PATH |
BackupPC Configuration Files | /etc/backuppc |
DATA_PATH |
BackupPC data backups | /var/lib/backuppc |
LOG_PATH |
Logfiles for BackupPC | /www/logs/backuppc |
SSH_KEYS_PATH |
SSH Keys Path | /home/.backuppc/.ssh |
By 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 you can set them here:
It's highly recommend you set at minimum:
NGINX_AUTHENTICATION_TYPE=BASIC
NGINX_AUTHENTICATION_BASIC_USER1=backuppc
NGINX_AUTHENTICATION_BASIC_PASS1=backuppc| Parameter | Description | Default |
|---|---|---|
NGINX_AUTHENTICATION_TYPE |
Protect the site with BASIC, LDAP, LLNG |
NONE |
NGINX_AUTHENTICATION_TITLE |
Challenge response when visiting protected site | Please login |
NGINX_AUTHENTICATION_BASIC_USER1 |
If BASIC chosen enter this for the username to protect site |
admin |
NGINX_AUTHENTICATION_BASIC_PASS1 |
If BASIC chosen enter this for the password to protect site |
password |
NGINX_AUTHENTICATION_BASIC_USER2 |
As above, increment for more users | |
NGINX_AUTHENTICATION_BASIC_PASS2 |
As above, increment for more users | |
NGINX_AUTHENTICATION_LDAP_HOST |
Hostname and port number of LDAP Server - ie ldap://ldapserver:389 |
|
NGINX_AUTHENTICATION_LDAP_BIND_DN |
User to Bind to LDAP - ie cn=admin,dc=orgname,dc=org |
|
NGINX_AUTHENTICATION_LDAP_BIND_PW |
Password for Above Bind User - ie password |
|
NGINX_AUTHENTICATION_LDAP_BASE_DN |
Base Distringuished Name - eg dc=hostname,dc=com |
|
NGINX_AUTHENTICATION_LDAP_ATTRIBUTE |
Unique Identifier Attrbiute -ie uid |
|
NGINX_AUTHENTICATION_LDAP_SCOPE |
LDAP Scope for searching - ie sub |
|
NGINX_AUTHENTICATION_LDAP_FILTER |
Define what object that is searched for (ie objectClass=person) |
|
NGINX_AUTHENTICATION_LDAP_GROUP_ATTRIBUTE |
If searching inside of a group what is the Group Attribute - ie uniquemember |
|
NGINX_AUTHENTICATION_LLNG_HANDLER_HOST |
If LLNG chosen use hostname of handler |
llng-handler |
NGINX_AUTHENTICATION_LLNG_HANDLER_PORT |
If LLNG chosen use this port for handler |
2884 |
NGINX_AUTHENTICATION_LLNG_ATTRIBUTE1 |
Syntax: HEADER_NAME, Variable, Upstream Variable - See note below | |
NGINX_AUTHENTICATION_LLNG_ATTRIBUTE2 |
Syntax: HEADER_NAME, Variable, Upstream Variable - See note below |
When 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:
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.
See the MSMTP Configuration Options for further information on options to configure MSMTP.
| Parameter | Description | Default |
|---|---|---|
SMTP_AUTO_FROM |
Add setting to support sending through Gmail SMTP | FALSE |
SMTP_HOST |
Hostname of SMTP Server | postfix-relay |
SMTP_PORT |
Port of SMTP Server | 25 |
SMTP_DOMAIN |
HELO Domain | docker |
SMTP_MAILDOMAIN |
Mail Domain From | local |
SMTP_AUTHENTICATION |
SMTP Authentication | none |
SMTP_USER |
SMTP Username | `` |
SMTP_PASS |
SMTP Password | `` |
SMTP_TLS |
Use TLS | FALSE |
SMTP_STARTTLS |
Start TLS from within session | FALSE |
SMTP_TLSCERTCHECK |
Check remote certificate | FALSE |
The following ports are exposed and available to public interfaces
| Port | Description |
|---|---|
80 |
HTTP |
NOTE: It is highly recommended this be run through a SSL proxy, or via localhost and tunnel via SSH.
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name is) bashThese 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.
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Sponsor me for personalized support
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Sponsor me regarding development of features.
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Sponsor me for up to date releases.
MIT. See LICENSE for more details.