hegedussz/backuppc repository overview

BackupPC forked from adferrand/backuppc

BackupPC is a free self-hosted backup software able to backup remote hosts through various ways like rsync, smb or tar. It supports full and incremental backups, and reconstruct automatically a usable verbatim from any backup version. Started with version 4, BackupPC uses a new way to store backups by a reverse delta approach and no hardlinks.

See BackupPC documentation⁠ for further details and how to use it. BackupPC 4.3.1 release: https://github.com/backuppc/backuppc/releases/tag/4.3.1⁠

⁠Basic usage

For testing purpose, you can create a new BackupPC instance with following command. Please note that the basic usage is not suitable for production use.

docker run \
    --name backuppc \
    --publish 80:80 \
    hegedussz/backuppc

⁠Backup service

With this image, you can create a BackupPc instance with default configuration and private key. The private key available for backuppc user only.

⁠How to use backup image

When you start the backup image, you can adjust the volumes for BackupPc configuration and data directory.

⁠Volumes for container

⁠/etc/backuppc

You can specify a path for this directory in the host computer, or from a data volume/container to customize the BackupPc application behavior.

⁠/var/lib/backuppc

You can specify a path for this directory in the host computer, or from a data volume/container to store the BackupPc data in different path, not in the container top layer.

ATTENTION

When you specify this directory, you MUST provide a private key for backuppc user on path /var/lib/backuppc/.ssh/ with name id_rsa.

⁠Environment variables

⁠BACKUPPC_PASSWD

Specify the password for backuppc user in basic authentication. When you open the backuppc site, which you can reach on container ip address with or without /backuppc path, you can login with backuppc user and BACKUPPC_PASSWD password.

This environment variable is optional, the default value is backuppc.

⁠hostname

BackupPC server hostname.

⁠LOGDIR

BackupPC log directory.

⁠TZ

Timezone (Default: Europe/Budapest)

⁠The default credentials are:

• username: backuppc

• password: backuppc

⁠UI authentication/authorization

By default, a single user with admin rights is created during the first start of the container. Its username is backuppc and its password is password.

The credentials are stored in the file /etc/backuppc/htpasswd to allow the embe$

You can modify the admin user credentials by setting the environment variables BACKUPPC_WEB_USER (default backuppc) and BACKUPPC_PASSWD (default password)` when creating the container.

The admin user credentials can be modified on an existing container by modifying the relevant environment variables, then re-creating the container.

However please note that if you modify the username, you will need to manually remove t$

⁠Advanced UI authentication/authorization

One may need more advanced authentication/authorization on Backuppc Web UI, for instance several normal users allowing operations on backups, and an admin user to parameterize BackupPC.

In theses cases, authentication and admin granting must be configured manually.

• Authentication is configured by providing credentials in the file /etc/backuppc/htpasswd of the container. You should use Apache htpasswd utility to fill it.

• All authenticated users are considered as normal users if not telling otherwise. Add a username in the $Conf{CgiAdminUsers} variable of /etc/backuppc/config.pl file to grant this user admin rights.

• Then default admin user creation is not needed : unset environment variables BACKUPPC_WEB_USER and BACKUPPC_WEB_PASSWD to avoid adding an additional user in the htpasswd file, and reconfigure admin rights in config.pl.