antipode.info/docker-backuppc
3
0
Fork 0
mirror of https://github.com/adferrand/docker-backuppc.git synced 2023-11-05 04:40:26 +01:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Adrien Ferrand 2017-04-20 19:37:21 +02:00 committed by GitHub
parent 5cf9dd3860
commit e00eb32406
1 changed files with 57 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -31,10 +31,12 @@ This docker is designed to provide a ready-to-go and maintainable BackupPC insta
For testing purpose, you can create a new BackupPC instance with following command.
docker run \
```bash
docker run \
--name backuppc \
--publish 80:8080 \
adferrand/backuppc:4.1.1
```
Docker image will be downloaded if needed, and started. After starting, browse http://YOUR_SERVER_IP:8080 to access the BackupPC web Admin UI. A user/password will be asked: they are backuppc/password. You can then test your BackupPC instance.
@ -46,33 +48,36 @@ As we are taking about backups, you certainly want to control the data persisten
It declares three volumes :
* /etc/backuppc: stores the BackupPC configuration, in particular config.pl and hosts configuration.
* /home/backuppc: home of the backuppc user, running your BackucPC instance, and contains in particular a .ssh directory with the SSH keys used to make backups through SSH protocol (see [SSH Keys](#ssh-keys)).
* /data/backuppc: contains the BackupPC pool, so your backups themselves.
* `/etc/backuppc`: stores the BackupPC configuration, in particular config.pl and hosts configuration.
* `/home/backuppc`: home of the backuppc user, running your BackucPC instance, and contains in particular a .ssh directory with the SSH keys used to make backups through SSH protocol (see [SSH Keys](#ssh-keys)).
* `/data/backuppc`: contains the BackupPC pool, so your backups themselves.
It is advised to mount these volumes on the host to persist your backups. Assuming a host directory /var/docker-data/backuppc{etc,home,data}, mounted on a big filesystem, you can do for instance :
It is advised to mount these volumes on the host to persist your backups. Assuming a host directory `/var/docker-data/backuppc{etc,home,data}`, mounted on a big filesystem, you can do for instance :
docker run \
```bash
docker run \
--name backuppc \
--public 80:8080 \
--volume /var/docker-data/backuppc/etc:/etc/backuppc \
--volume /var/docker-data/backuppc/home:/home/backuppc \
--volume /var/docker-data/backuppc/data:/data/backuppc \
adferrand/backuppc:4.1.1
```
All your backuppc configuration, backup and keys will survive the container destroy/re-creation.
## POSIX rights
The mounted host directory used for data persistency need to be accessible by the host user corresponding to the backuppc user created in container instance. By default, this backuppc user is of UUID 1000 and GUID 1000, which should corresponds to the first non-root user create on your host.
The mounted host directory used for data persistency need to be accessible by the host user corresponding to the backuppc user created in container instance. By default, this backuppc user is of `UUID 1000` and `GUID 1000`, which should corresponds to the first non-root user create on your host.
If you want to use an host user of different UUID/GUID, you can specify the container instance to use these customized values during creation with environment variables: respectively BACKUPPC_UUID (default: 1000) and BACKUPPC_GUID (default: 1000).
If you want to use an host user of different UUID/GUID, you can specify the container instance to use these customized values during creation with environment variables: respectively `BACKUPPC_UUID (default: 1000)` and `BACKUPPC_GUID (default: 1000)`.
For example:
# With user myUser (UUID 1200) and group myGroup (GUID 1300)
chown -R myUser:myGroup /var/docker-data/backuppc
docker run \
```bash
# With user myUser (UUID 1200) and group myGroup (GUID 1300)
chown -R myUser:myGroup /var/docker-data/backuppc
docker run \
--name backuppc \
--public 80:8080 \
--volume /var/docker-data/backuppc/etc:/etc/backuppc \
@ -81,6 +86,7 @@ For example:
--env 'BACKUPPC_UUID=1200' \
--env 'BACKUPPC_GUID=1300' \
adferrand/backuppc:4.1.1
```
# UI SSL encryption
@ -88,12 +94,14 @@ By default, BackupPC web Admin UI is exposed by the non secured HTTP protocol. T
## Self-signed certificate
Set the environment variable USE_SSL (default: false) to true, and the embedded lighttpd server will expose the UI by HTTPS protocol, using a self-signed certificate generated during first run of the container instance.
Set the environment variable `USE_SSL (default: false)` to `true`, and the embedded lighttpd server will expose the UI by HTTPS protocol, using a self-signed certificate generated during first run of the container instance.
docker run \
```bash
docker run \
--name backuppc \
--public 443:8080
--env 'USE_SSL=true'
```
Then you can access the UI through the secured URL https://YOUR_SERVER_IP/. Of course, as the SSL certificate is self-signed, your browser will alert you about this unsecured certificate.
@ -109,7 +117,7 @@ To update the BackupPC version of this container:
* pull the new image version of this Docker,
* recreate the container.
At first start, configure.pl script of BackupPC will be called. It will detect your existing configuration (under /etc/backuppc), your existing backup pool (under /data/backuppc), and will proceed any changes needed to match the new BackupPC version requirement.
At first start, `configure.pl` script of BackupPC will be called. It will detect your existing configuration (under `/etc/backuppc`), your existing backup pool (under `/data/backuppc`), and will proceed any changes needed to match the new BackupPC version requirement.
## Dockerising an existing BackupPC v3.x
@ -118,21 +126,23 @@ This sub-section is under Upgrading section because the process is very similar
Because configure.pl script is called on first run of your container instance, you can dockerise and upgrade to v4.X a pre-existing BackupPC v3.x installation.
Do to so, let's assume that your BackupPC v3.x installed on your host:
* has its configuration in /etc/backuppc
* has its backup pool in /var/lib/backuppc
* has the user home running your BackupPC (typically backuppc) in /home/backuppc
* has its configuration in `/etc/backuppc`
* has its backup pool in `/var/lib/backuppc`
* has the user home running your BackupPC (typically backuppc) in `/home/backuppc`
Check UUID/GUID of your backuppc user on host. If they are not 1000/1000, you will need to put environment variables to customize theses values in the container instance (see [POSIX rights](#posix-rights)).
Then launch a container instance, mounting your existing BackupPC installation assets in the relevant volumes.
docker run \
```bash
docker run \
--name backuppc \
--public 80:8080 \
--volume /etc/backuppc:/etc/backuppc \
--volume /home/backuppc:/home/backuppc \
--volume /var/lib/backuppc:/data/backuppc \
adferrand/backuppc:4.1.1
```
The configure.pl script will detect a v3.x version under /etc/backuppc, and will run appropriate upgrade operations (in particular enabling legacy v3.x pool to access it from a BackupPC v4.x).
@ -140,6 +150,8 @@ The configure.pl script will detect a v3.x version under /etc/backuppc, and will
For debugging and maintenance purpose, you may need to start a shell in your running container. With a Docker of version 1.3.0 or higher, you can do:
docker exec -it backuppc /bin/sh
```bash
docker exec -it backuppc /bin/sh
```
You will have the standard tools of an Alpine distribution.