Docker container for CrashPlan PRO

This is a Docker container for CrashPlan PRO.

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.

IMPORTANT: This container can be used to migrate from CrashPlan for Home. Make sure to read the Migrating From CrashPlan for Home section for more details.

CrashPlan offers the most comprehensive online backup solution to tens of thousands of businesses around the world. The highly secure, automatic and continuous service provides customers the peace of mind that their digital life is protected and easily accessible.

Table of Content

Docker container for CrashPlan PRO

Quick Start

NOTE: The Docker command provided in this quick start is given as an example and parameters should be adjusted to your need.

Launch the CrashPlan PRO docker container with the following command:

docker run -d \
    --name=crashplan-pro \
    -p 5800:5800 \
    -v /docker/appdata/crashplan-pro:/config:rw \
    -v $HOME:/storage:ro \
    jlesage/crashplan-pro

Where:

/docker/appdata/crashplan-pro: 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.

Browse to http://your-host-ip:5800 to access the CrashPlan PRO GUI. Files from the host appear under the /storage folder in the container.

Usage

docker run [-d] \
    --name=crashplan-pro \
    [-e <VARIABLE_NAME>=<VALUE>]... \
    [-v <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]]... \
    [-p <HOST_PORT>:<CONTAINER_PORT>]... \
    jlesage/crashplan-pro

Parameter	Description
-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.

Environment Variables

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 <VARIABLE_NAME>=<VALUE>.

Variable	Description	Default
`USER_ID`	ID of the user the application runs as. See User/Group IDs to better understand when this should be set.	`1000`
`GROUP_ID`	ID of the group the application runs as. See User/Group IDs to better understand when this should be set.	`1000`
`SUP_GROUP_IDS`	Comma-separated list of supplementary group IDs of the application.	(unset)
`UMASK`	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 `022` is used, meaning that newly created files are readable by everyone, but only writable by the owner. See the following online umask calculator: http://wintelguy.com/umask-calc.pl	(unset)
`TZ`	TimeZone of the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container.	`Etc/UTC`
`KEEP_APP_RUNNING`	When set to `1`, the application will be automatically restarted if it crashes or if user quits it.	`0`
`APP_NICENESS`	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 `--cap-add=SYS_NICE`.	(unset)
`CLEAN_TMP_DIR`	When set to `1`, all files in the `/tmp` directory are delete during the container startup.	`1`
`DISPLAY_WIDTH`	Width (in pixels) of the application's window.	`1280`
`DISPLAY_HEIGHT`	Height (in pixels) of the application's window.	`768`
`SECURE_CONNECTION`	When set to `1`, an encrypted connection is used to access the application's GUI (either via web browser or VNC client). See the Security section for more details.	`0`
`VNC_PASSWORD`	Password needed to connect to the application's GUI. See the VNC Password section for more details.	(unset)
`X11VNC_EXTRA_OPTS`	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)
`ENABLE_CJK_FONT`	When set to `1`, open source computer font `WenQuanYi Zen Hei` is installed. This font contains a large range of Chinese/Japanese/Korean characters.	`0`
`CRASHPLAN_SRV_MAX_MEM`	Maximum amount of memory the CrashPlan Engine is allowed to use. One of the following memory unit (case insensitive) should be added as a suffix to the size: `G`, `M` or `K`. By default, when this variable is not set, a maximum of 1024MB (`1024M`) of memory is allowed. NOTE: Setting this variable as the same effect as running the `java mx VALUE, restart` command from the CrashPlan command line.	(unset)

Data Volumes

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 format: <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS].

Container path	Permissions	Description
`/config`	rw	This is where the application stores its configuration, log and any files needing persistency.
`/storage`	ro	This location contains files from your host that need to be accessible by the application.

Ports

Here is the list of ports used by the container. They can be mapped to the host via the -p parameter (one per port mapping). Each mapping is defined in the following format: <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.

Changing Parameters of a Running Container

As seen, environment variables, volume mappings and port mappings are specified while creating the container.

The following steps describe the method used to add, remove or update parameter(s) of an existing container. The generic idea is to destroy and re-create the container:

Stop the container (if it is running):

docker stop crashplan-pro

Remove the container:

docker rm crashplan-pro

Create/start the container using the docker run command, by adjusting parameters as needed.

NOTE: Since all application's data is saved under the /config container folder, destroying and re-creating a container is not a problem: nothing is lost and the application comes back with the same state (as long as the mapping of the /config folder remains the same).

Docker Compose File

Here is an example of a docker-compose.yml file that can be used with Docker Compose.

Make sure to adjust according to your needs. Note that only mandatory network ports are part of the example.

version: '3'
services:
  crashplan-pro:
    build: .
    ports:
      - "5800:5800"
    volumes:
      - "/docker/appdata/crashplan-pro:/config:rw"
      - "$HOME:/storage:ro"

Docker Image Update

If the system on which the container runs doesn't provide a way to easily update the Docker image, the following steps can be followed:

Fetch the latest image:

docker pull jlesage/crashplan-pro

Stop the container:

docker stop crashplan-pro

Remove the container:

docker rm crashplan-pro

Start the container using the docker run command.

Synology

For owners of a Synology NAS, the following steps can be use to update a container image.

Open the Docker application.
Click on Registry in the left pane.
In the search bar, type the name of the container (jlesage/docker-crashplan-pro).
Select the image, click Download and then choose the latest tag.
Wait for the download to complete. A notification will appear once done.
Click on Container in the left pane.
Select your CrashPlan PRO container.
Stop it by clicking Action->Stop.
Clear the container by clicking Action->Clear. This removes the container while keeping its configuration.
Start the container again by clicking Action->Start. NOTE: The container may temporarily disappear from the list while it is re-created.

unRAID

For unRAID, a container image can be updated by following these steps:

Select the Docker tab.
Click the Check for Updates button at the bottom of the page.
Click the update ready link of the container to be updated.

User/Group IDs

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 USER_ID and 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:

id <username>

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

Security

By default, access to the application's GUI is done over an unencrypted connection (HTTP or VNC).

Secure connection can be enabled via the SECURE_CONNECTION environment 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 HTTPs.

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.

Certificates

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.

Container Path	Purpose	Content
`/config/certs/vnc-server.pem`	VNC connection encryption.	VNC server's private key and certificate, bundled with any root and intermediate certificates.
`/config/certs/web-privkey.pem`	HTTPs connection encryption.	Web server's private key.
`/config/certs/web-fullchain.pem`	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.

VNC Password

To restrict access to your application, a password can be specified. This can be done via two methods:

By using the VNC_PASSWORD environment variable.
By creating a .vncpass_clear file at the root of the /config volume. This file should contains the password in clear-text. During the container startup, content of the file is obfuscated and moved to .vncpass.

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.

ATTENTION: Password is limited to 8 characters. This limitation comes from the Remote Framebuffer Protocol RFC (see section 7.2.2). Any characters beyhond the limit are ignored.

Shell Access

To get shell access to a the running container, execute the following command:

docker exec -ti CONTAINER sh

Where CONTAINER is the ID or the name of the container used during its creation (e.g. crashplan-pro).

Reverse Proxy

The following sections contains NGINX configuration that need to be added in order to reverse proxy to this container.

A reverse proxy server can route HTTP requests based on the hostname or the URL path.

Routing Based on Hostname

In this scenario, each hostname is routed to a different application/container.

For example, let's say the reverse proxy server is running on the same machine as this container. The server would proxy all HTTP requests sent to crashplan-pro.domain.tld to the container at 127.0.0.1:5800.

Here are the relevant configuration elements that would be added to the NGINX configuration:

map $http_upgrade $connection_upgrade {
	default upgrade;
	''      close;
}

upstream docker-crashplan-pro {
	# If the reverse proxy server is not running on the same machine as the
	# Docker container, use the IP of the Docker host here.
	# Make sure to adjust the port according to how port 5800 of the
	# container has been mapped on the host.
	server 127.0.0.1:5800;
}

server {
	[...]

	server_name crashplan-pro.domain.tld;

	location / {
	        proxy_pass http://docker-crashplan-pro;
	}

	location /websockify {
		proxy_pass http://docker-crashplan-pro;
		proxy_http_version 1.1;
		proxy_set_header Upgrade $http_upgrade;
		proxy_set_header Connection $connection_upgrade;
		proxy_read_timeout 86400;
	}
}

Routing Based on URL Path

In this scenario, the hostname is the same, but different URL paths are used to route to different applications/containers.

For example, let's say the reverse proxy server is running on the same machine as this container. The server would proxy all HTTP requests for server.domain.tld/crashplan-pro to the container at 127.0.0.1:5800.

Here are the relevant configuration elements that would be added to the NGINX configuration:

map $http_upgrade $connection_upgrade {
	default upgrade;
	''      close;
}

upstream docker-crashplan-pro {
	# If the reverse proxy server is not running on the same machine as the
	# Docker container, use the IP of the Docker host here.
	# Make sure to adjust the port according to how port 5800 of the
	# container has been mapped on the host.
	server 127.0.0.1:5800;
}

server {
	[...]

	location = /crashplan-pro {return 301 $scheme://$http_host/crashplan-pro/;}
	location /crashplan-pro/ {
		proxy_pass http://docker-crashplan-pro/;
		location /crashplan-pro/websockify {
			proxy_pass http://docker-crashplan-pro/websockify/;
			proxy_http_version 1.1;
			proxy_set_header Upgrade $http_upgrade;
			proxy_set_header Connection $connection_upgrade;
			proxy_read_timeout 86400;
		}
	}
}

Taking Over Existing Backup

If this container is replacing a CrashPlan installation (from Linux, Windows, MAC or another Docker container), your existing backup can be taken over to avoid re-uploading all your data.

To proceed, make sure to carefully read the official documentation.

Here is a summary of what needs to be done:

Start CrashPlan Docker container. Make sure the configuration directory is not mapped to a folder used by a different CrashPlan container.
Sign in to your account.
Click the Replace Existing button to start the wizard.
Skip Step 2 - File Transfert.
Once done with the wizard, go to your device's details and click Manage Files. You will probably see missing items in the file selection. This is normal, since path to your files may be different in the container.
Update the file selection by re-adding your files. Do not unselect missing items yet.
Perform a backup. Because of deduplication, files will not be uploaded again.
Once the backup is terminated, you can remove missing items if you don't care about file versions. Else, keep missing items.

NOTE: Don't be confused by the directory structure from your old being visible in the Manage Files window. By default, your files are now located under the /storage folder.

Migrating From CrashPlan for Home

CrashPlan for Home being decommissioned, users using this version have the choice to migrate their account to CrashPlan PRO (aka CrashPlan for Small Business). Thus, using this container becomes a great choice for these users.

To perform the transition, you need to:

Migrate your account.
If CrashPlan for Home installation is provided by the jlesage/crashplan Docker container:
- Keep the configuration directory used by jlesage/crashplan container (i.e. the host directory mapped to /config).
- Run this container by re-using the same configuration directory. To do so, map the /config folder to the same host directory used by the jlesage/crashplan container.
Else, for all other installations (Windows, Linux, Mac, other Docker containers):
- Start this container, by making sure the configuration directory is mapped to a new, empty host directory.
- Follow instructions detailed in the Taking Over Existing Backup section.

Troubleshooting

Crashes / Maximum Amount of Allocated Memory

If CrashPlan crashes unexpectedly with large backups, try to increase the maximum amount of memory CrashPlan is allowed to use. This can be done by:

Setting the CRASHPLAN_SRV_MAX_MEM environment variable. See the Environment Variables section for more details.
Using the solution provided by CrashPlan from its support site.

Inotify's Watch Limit

If CrashPlan exceeds inotify's max watch limit, real-time file watching cannot work properly and the inotify watch limit needs to be increased on the host, not the container.

For more details, see the CrashPlan's Linux real-time file watching errors article.

Synology

On Synology NAS, the instuctions provided by the article mentioned in the previous section apply, except that the inotify's max watch limit must be set in /etc.defaults/sysctl.conf (instead of /etc/sysctl.conf) to make the setting permanent.

NOTE: After an upgrade of the DSM software, verify that the content of the file has not been overwritten.

Empty `/storage`

If the /storage folder inside the container is empty:

Make sure the folder is properly mapped to the host. This is done via the -v parameter of the docker run command. See the Usage section.
Make sure permissions and ownership of files on the host are correct and are compatible with the user under which the container application is running (defined by the USER_ID and GROUP_ID environment variables). See the User/Group IDs section.

NOTE: If running the application as root (USER_ID=0 and GROUP_ID=0) makes the files visible, it confirms that there is a permission issue.

Device Status Is Waiting For Connection

If the status of your device is stuck on Waiting for connection, clearing the the cache of CrashPlan can help resolve the issue:

Stop the container.
Remove all the content of the cache directory found under the container's configuration directory. For example, if the /config folder of the container is mapped to /docker/appdata/crashplan-pro on the host, the following command (ran on the host) would clear the cache:
```
rm -rf /docker/appdata/crashplan-pro/cache/*
```
Start the container.

Cannot Restore Files

If CrashPlan fails to restore files, make sure the location where files are restored have write permission.

A typical installation has the data to be backup under the /storage folder. This folder is usually mapped to the host with read-only permission. Thus, restoring files to /storage won't be allowed. The solution is to temporarily change the permission of the volume to read-write.

For example, if /storage is mapped to $HOME on the host, the container would need to be deleted and then re-created with the same arguments, with the exception of -v $HOME:/storage:ro that is replaced with -v $HOME:/storage:rw.

Upgrade Failed Error Message

Because the CrashPlan's self-upgrade feature is disabled in this container, an error message about failed upgrade can be seen when a new CrashPlan version is released.

To fix this, updating the container's image to the latest version will also bring the latest version of CrashPlan.

Support or Contact

Having troubles with the container or have questions? Please create a new issue.

mthlvt/docker-crashplan-pro

Docker container for CrashPlan PRO

Table of Content

Quick Start

Usage

Environment Variables

Data Volumes

Ports

Changing Parameters of a Running Container

Docker Compose File

Docker Image Update

Synology

unRAID

User/Group IDs

Accessing the GUI

Security

Certificates

VNC Password

Shell Access

Reverse Proxy

Routing Based on Hostname

Routing Based on URL Path

Taking Over Existing Backup

Migrating From CrashPlan for Home

Troubleshooting

Crashes / Maximum Amount of Allocated Memory

Inotify's Watch Limit

Synology

Empty /storage

Device Status Is Waiting For Connection

Cannot Restore Files

Upgrade Failed Error Message

Support or Contact

Empty `/storage`