Docker container for CloudBerry Backup
This is a Docker container for CloudBerry Backup.
The GUI of the application is accessed through a modern web browser (no installation or configuration needed on client side) or via any VNC client.
Backup files and folders to cloud storage of your choice: Amazon S3, Azure Blob Storage, Google Cloud Storage, HP Cloud, Rackspace Cloud Files, OpenStack, DreamObjects and other.
Launch the CloudBerry Backup docker container with the following command:
docker run -d \ --name=cloudberry-backup \ -p 5800:5800 \ -p 5900:5900 \ -v /docker/appdata/cloudberry-backup:/config:rw \ -v $HOME:/storage:ro \ jlesage/cloudberry-backup
/docker/appdata/cloudberry-backup: This is where the application stores its configuration, log and any files needing persistency.
$HOME: This location contains files from your host that need to be accessible by the application.
http://your-host-ip:5800 to access the CloudBerry Backup GUI. Files from
the host appear under the
/storage folder in the container.
docker run [-d] \ --name=cloudberry-backup \ [-e <VARIABLE_NAME>=<VALUE>]... \ [-v <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]]... \ [-p <HOST_PORT>:<CONTAINER_PORT>]... \ jlesage/cloudberry-backup
|-d||Run the container in background. If not set, the container runs in foreground.|
|-e||Pass an environment variable to the container. See the Environment Variables section for more details.|
|-v||Set a volume mapping (allows to share a folder/file between the host and the container). See the Data Volumes section for more details.|
|-p||Set a network port mapping (exposes an internal container port to the host). See the Ports section for more details.|
To customize some properties of the container, the following environment
variables can be passed via the
-e parameter (one for each variable). Value
of this parameter has the format
||ID of the user the application runs as. See User/Group IDs to better understand when this should be set.||
||ID of the group the application runs as. See User/Group IDs to better understand when this should be set.||
||Comma-separated list of supplementary group IDs of the application.||(unset)|
||Mask that controls how file permissions are set for newly created files. The value of the mask is in octal notation. By default, this variable is not set and the default umask of
||TimeZone of the container. Timezone can also be set by mapping
||When set to
||Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. By default, niceness is not set, meaning that the default niceness of 0 is used. NOTE: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option
||When set to
||Width (in pixels) of the application's window.||
||Height (in pixels) of the application's window.||
||When set to
||Password needed to connect to the application's GUI. See the VNC Password section for more details.||(unset)|
||Extra options to pass to the x11vnc server running in the Docker container. WARNING: For advanced users. Do not use unless you know what you are doing.||(unset)|
||Username to use to login to the CloudBerry Backup's web interface.||(unset)|
||Password to use to login to the CloudBerry Backup's web interface.[br][span style='color: red;'][b]Warning:[/b][/span] See documentation for a more secure way to specify the password.||(unset)|
The following table describes data volumes used by the container. The mappings
are set via the
-v parameter. Each mapping is specified with the following
||rw||This is where the application stores its configuration, log and any files needing persistency.|
||ro||This location contains files from your host that need to be accessible by the application.|
Here is the list of ports used by the container. They can be mapped to the host
-p parameter (one per port mapping). Each mapping is defined in the
<HOST_PORT>:<CONTAINER_PORT>. The port number inside the
container cannot be changed, but you are free to use any port on the host side.
|Port||Mapping to host||Description|
|5800||Mandatory||Port used to access the application's GUI via the web interface.|
|5900||Optional||Port used to access the application's GUI via the VNC protocol. Optional if no VNC client is used.|
|43210||Optional||Port used to access the CloudBerry Backup's web interface via HTTP.|
|43211||Optional||Port used to access the CloudBerry Backup's web interface via HTTPs.|
When using data volumes (
-v flags), permissions issues can occur between the
host and the container. For example, the user within the container may not
exists on the host. This could prevent the host from properly accessing files
and folders on the shared volume.
To avoid any problem, you can specify the user the application should run as.
This is done by passing the user ID and group ID to the container via the
GROUP_ID environment variables.
To find the right IDs to use, issue the following command on the host, with the
user owning the data volume on the host:
Which gives an output like this one:
uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)
The value of
uid (user ID) and
gid (group ID) are the ones that you should
be given the container.
Accessing the GUI
Assuming that container's ports are mapped to the same host's ports, the
graphical interface of the application can be accessed via:
A web browser:
http://<HOST IP ADDR>:5800
Any VNC client:
<HOST IP ADDR>:5900
By default, access to the application's GUI is done over an unencrypted
connection (HTTP or VNC).
Secure connection can be enabled via the
variable. See the Environment Variables section for
more details on how to set an environment variable.
When enabled, application's GUI is performed over an HTTPs connection when
accessed with a browser. All HTTP accesses are automatically redirected to
When using a VNC client, the VNC connection is performed over SSL. Note that
few VNC clients support this method. [SSVNC] is one of them.
Here are the certificate files needed by the container. By default, when they
are missing, self-signed certificates are generated and used. All files have
PEM encoded, x509 certificates.
||VNC connection encryption.||VNC server's private key and certificate, bundled with any root and intermediate certificates.|
||HTTPs connection encryption.||Web server's private key.|
||HTTPs connection encryption.||Web server's certificate, bundled with any root and intermediate certificates.|
NOTE: To prevent any certificate validity warnings/errors from the browser
or VNC client, make sure to supply your own valid certificates.
NOTE: Certificate files are monitored and relevant daemons are automatically
restarted when changes are detected.
To restrict access to your application, a password can be specified. This can
be done via two methods:
- By using the
- By creating a
.vncpass_clearfile at the root of the
This file should contains the password in clear-text. During the container
startup, content of the file is obfuscated and moved to
The level of security provided by the VNC password depends on two things:
- The type of communication channel (encrypted/unencrypted).
- How secure access to the host is.
When using a VNC password, it is highly desirable to enable the secure
connection to prevent sending the password in clear over an unencrypted channel.
CloudBerry Backup Web Interface
CloudBerry Backup provides its own web interface. It can be accessed via HTTP
port 43210 and/or HTTPs port 43211.
A username and password must be configured before being able to login to the web interface.
The username is set via the
CBB_WEB_INTERFACE_USER environment variable.
There are two ways of setting the password:
- Via the
- By storing the password hash in
The password hash can be generated by the command
mkpasswd. For example, to
generate the hash using the SHA-512 method:
mkpasswd -m sha-512
The whole output of the command must be saved into
/config/.cbb_web_interface_pass_hash. Here is an example of the output:
An other way of generating the password hash is to set the password in
/config/.cbb_web_interface_clear_text_pass. When the container
starts, a hash is performed using the content of this file and is automatically
/config/.cbb_web_interface_pass_hash. Then, the clear-text password
file is deleted.
Support or Contact
Having troubles with the container or have questions? Please
create a new issue.