crashplan-docker-synology

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

crashplan-docker-synology

★ 27 Open GitHub ↗

Run a headless CrashPlan instance on a Synology device with Docker

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# crashplan-docker-synology

[![Join the chat at https://gitter.im/ajkerrigan/crashplan-docker-synology](https://badges.gitter.im/ajkerrigan/crashplan-docker-synology.svg)](https://gitter.im/ajkerrigan/crashplan-docker-synology?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Update: The End of CrashPlan for Home

As of 2017-August-22, Code42 no longer offers CrashPlan for Home. Existing subscriptions will be honored through October of 2018 (see [this announcement](https://www.crashplan.com/en-us/consumer/nextsteps/) for more information).

Running CrashPlan from a NAS has always been a neglected use case from a support perspective, so this move isn't all that surprising. Still, this leaves a question for those of us currently relying on CrashPlan for Home... what do we do instead?

Like many of you, I'll be revisiting other backup options that I previously rejected and many new ones that have arisen over the past few years.

[FernandoMiguel](https://github.com/FernandoMiguel) has created an excellent [sheet](https://docs.google.com/spreadsheets/d/18uZnV-vG8J0jC-pg_v_ozY1BlwYQG6kbOJCAsW_ZGWE/edit#gid=0) comparing various cloud backup/storage offerings. I hope that it is useful to the rest of you who are planning your migrations.

## Overview

This is an attempt to get CrashPlan running on a Synology NAS inside a Docker container. It has been tested successfully in the following configurations:

DSM Version: 6.0-7321

Device | RAM
-------|----
Synology DS713+ | 4GB
Synology DS412+ | 2GB

I have been running the [PC Load Letter CrashPlan Packages](http://pcloadletter.co.uk/2012/01/30/crashplan-syno-package/)
for a long time. They certainly made it much easier to deal with CrashPlan updates,
but it was still fairly common for me to have issues after new releases. When I had
issues with the 4.4.1 release, I decided to see if Docker would be a smoother way forward.

## Assumptions and Precautions

This documentation assumes that:

* You have a CrashPlan account, a Synology device and some experience using them together
* Your Synology device supports Docker (check compatibility [here](https://www.synology.com/en-us/dsm/app_packages/Docker))
* You are comfortable connecting to your Synology device using SSH and running terminal commands
* Docker experience *shouldn't* be necessary, but can't hurt :)

Before trying to run CrashPlan in a Docker container, it's a good idea to:

* Back up your CrashPlan configuration files related to any currently installed instances of CrashPlan, in case you decide to switch back to your previous setup
* Stop or uninstall existing CrashPlan instances

## Installation
* Install the Docker package via the DSM Package Manager
* Stop any existing CrashPlan instances
* SSH to your Synology NAS
* Clone this repository to /root
    * Note: If you don't have `git` installed, install the `ipkg` package manager and install it.
    * ipkg install help [here](http://www.ingmarverheij.com/how-to-install-ipkg-on-synology-nas-ds212/)
* Symbolically link the start up script
   * `ln -s /root/crashplan-docker-synology/S99crashplandocker.sh /usr/local/etc/rc.d/S99crashplandocker.sh`
* Review the predefined variables in the S99crashplandocker.sh script. If you have different locations for your installation, you will need to update the variables.
    * Copy the user variables file to /root
        * `cp /root/crashplan-docker-synology/cp-user-vars.sh /root`
    * Edit `/root/cp-user-vars.sh`
    * Save the file
* Run `/usr/local/etc/rc.d/S99crashplandocker.sh start` to start the container.
* Wait 10-20 seconds
* Run `/usr/local/etc/rc.d/S99crashplandocker.sh status` to see the running state of the container
   * This command also shows the authorization token required for accessing the CrashPlan UI from a remote computer
* Connect to the headless service using CrashPlan Desktop on a remote computer.
   * See [CrashPlan's documentation](http://support.code42.com/CrashPlan/4/Configuring/Using_CrashPlan_On_A_Headless_Computer) for help with this, and consult `/usr/local/etc/rc.d/S99crashplandocker.sh status` for details about the running CrashPlan instance.

## Upgrading

The CrashPlan service running in your Docker container will update itself automatically.
However, follow the steps below to make sure the Docker image is up to date.

* To check for updates to the Docker image, run `docker pull ajkerrigan/crashplan`
* If the image was updated, run `/usr/local/etc/rc.d/S99crashplandocker.sh recreate` to create and start a container based on the new image.

* Note: It's a good idea to run the steps above after upgrading DSM (for example,
after moving from DSM 5.2 to 6.0).

## Customization

This script can be customized to suit your specific needs. Customization is done within the `cp-user-vars.sh` file which should be located in `/root`. The options most likely to need tweaking are:
* `USER_VOLUMES`: The `-v` options passed to the `docker run` command. These control the paths that will be mounted inside the container. 
* `CRASHPLAN_DIR`: The CrashPlan home/installation directory. When switching from an existing install of CrashPlan, pointing this variable to your current installation may avoid the need to "adopt" the previous installation from
the CrashPlan client.
* `DATA_DIR`: The destination for incoming backups. Setting this to a data directory from an existing installation will save some time synchronizing backup progress.

## Caveats

* Because this script sets up mounted volumes that are not accessible from the DSM GUI, trying to manage this container from the Synology Docker GUI will break it. Checking status and resource utilization with the GUI is fine, but trying to start the container from the GUI will break the volume configuration.
If that happens, remove the container and run `/usr/local/etc/rc.d/S99crashplandocker.sh start` again to set it up anew.

* Anytime the container stops and restarts, it's going to overwrite the `.ui_info` file. That file contains an authentication token GUID that needs to be the same on the CrashPlan Desktop client and the server. Before trying to start your CrashPlan client, run `/usr/local/etc/rc.d/S99crashplandocker.sh status` and take note of the `Auth Token`. Use that to update the `.ui_info` file on your client machine.
See CrashPlan's [documentation for headless computers](http://support.code42.com/CrashPlan/4/Configuring/Using_CrashPlan_On_A_Headless_Computer#Step_1:_Copy_The_Authentication_Token) for more information.

## Acknowledgements

* gfjardim's Docker Image for CrashPlan (https://hub.docker.com/r/gfjardim/crashplan/)
was an excellent starting point. I forked it into the `ajkerrigan/crashplan` image
with the expectation that I'd tweak things as I went along.

* patters over at [PC Load Letter](http://pcloadletter.co.uk/) is a damn hero.
He has been wrestling with getting CrashPlan to work on Synology devices for years,
and has done a lot of work so that people like me could be lazier. He accepts donations,
and damn well deserves them. His
[CrashPlan packages](http://pcloadletter.co.uk/2012/01/30/crashplan-syno-package/)
are the only reason I haven't given up running CrashPlan on my NAS by now.

* Scott Hanselman's [blog post](http://www.hanselman.com/blog/UPDATED2014HowToSetupCrashPlanCloudBackupOnASynologyNASRunningDSM50.aspx)
is an excellent walkthrough of getting CrashPlan installed and running. His post is
very readable and supported by plenty of screenshots.

## Troubleshooting

* Running CrashPlan on a Synology device has always been a quirky endeavor. I believe Docker removes some of the wonkiness, but I'm sure there are issues I haven't run into yet. I am not an expert on this stuff, but I've broken and fixed enough CrashPlan installations that I'm familiar with some of the ways things break. If you have issues you can't fix on your own, please open an issue in GitHub and I'll try to help.

## Contributing

* Do you have suggestions for how this script can be better written or better documented?
Please open an issue, or fix it yourself and submit a pull request.

## Additional Resources

* [PC Load Letter's CrashPlan packages](http://pcloadletter.co.uk/2012/01/30/crashplan-syno-package/).
If you're not using Docker, use those packages.
* Docker Hub pages for the [ajkerrigan/crashplan](https://hub.docker.com/r/ajkerrigan/crashplan/) image,
or the [gfjardim/crashplan](https://hub.docker.com/r/gfjardim/crashplan/) image it was based on.
* gfjardim's [docker-containers](https://github.com/gfjardim/docker-containers) GitHub repository.
* [CrashPlan Headless documentation](http://support.code42.com/CrashPlan/4/Configuring/Using_CrashPlan_On_A_Headless_Computer).

crashplan-docker-synology

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README