A CrashPlan installer for Synology NAS.
Verified on DSM version: DSM 6.1.1-15101 Update 1
- Synology NAS
- Perl (install via Synology Package Center)
- ipkg/optware
- URL I found with decent instructions: http://www.vspecialist.co.uk/2014/09/how-to-install-ipkg-on-a-synology-nas/
- URL before Synology took it down: http://forum.synology.com/wiki/index.php/How_to_Install_Bootstrap
- ipkg packages:
- bash
- coreutils
whoused by CrashPlan installerbasenameused by CrashPlan Health Check
- cpio (used by CrashPlan installer)
- screen
- sed (used by CrashPlan installer)
- wget-ssl (if you are downloading from CrashPlan's site)
- remove wget first
- Optware fix from http://forum.synology.com/enu/viewtopic.php?f=77&t=51025
I have removed the /opt mount that the bootstrap install creates as it prevents the DSM from working properly: I have verified that upgrades and volume creation fail with the /opt mount.
To remove the /opt mount:
- umount /opt
- rmdir /opt (this should be an empty directory)
- ln -s /volume1/@optware /opt
At some point in DSM 6.x (maybe the first release), Synology updated the mv and cp binaries and now the -v option works. The problem is that now the auto-upgrade scripts from CrashPlan now partially work and do enough to completely break the installation. My fix for this is to add a symbolic link to /opt/bin/cpio at /bin/cpio. This script will create this for you now, but I'm leaving this information in the README for now. Here's the command to implement this manually, in case you need it:
ln -s /opt/bin/cpio /bin/cpio
CrashPlan's instructions: https://support.code42.com/CrashPlan/4/Troubleshooting/Linux_Real-Time_File_Watching_Errors
I believe that as of DSM 6.1, the method described on CrashPlan's site on increasing the max_user_watches became invalid. This is because Synology uses their own configuration file for setting max_user_watches. This script will edit /etc.defaults/synoinfo.conf and set the s2s_watches_max value to CrashPlan's recommended value of 1048576.
This script has been quite a while in the making. Like me, if you've had the problem where CrashPlan would sometimes terminate unexpectedly and you would find out with CrashPlan's 3-day or 5-day email, then you definitely want to set this up. You will need to create the Synology schedule task manually, however, as follows:
IMPORTANT: You should copy this script to /opt
- Log into DSM, open the Control Panel, and then Task Scheduler.
- Create a task with the following attributes:
- User: root
- Schedule: Daily at 00:00, every 10 minutes, until 23:50 (whatever you want)
- User-defined script: /opt/CrashPlanHealthCheck.sh
The script will log to CrashPlanHealthCheck.log when it restarts CrashPlan.
After a DSM upgrade, the /opt softlink is lost as well as other customizations. This script restores them.
NOTE: This needs to be run first after any DSM upgrade where you've lost /opt.
Usage:
./fixoptware.sh
When logging in as root, the modifications fixoptware.sh makes to /etc/profile to update PATH don't work. I'm still working on figuring this out. optpath.sh can be used to add /opt/bin:/opt/sbin to your PATH.
Usage:
source optpath.sh
This script automates (as much as possible) of the CrashPlan install on subsequent modifications. Before running the install, the script provides you the path information to provide the CrashPlan install script.
After installation, this script enables CrashPlan for remote management so you don't have to use the SSH tunnel as described on CrashPlan's web site (you can still use it if you want, though).
Usage:
./SynoCrashPlanInstall.sh <CrashPlan-tgz-file>
For those of us who have very large backup sets, the default java heap size may not
be enough to keep CrashPlan from crashing due to Out of Memory errors. This is a
known issue and this script will help you adjust your system, if you have the
capacity. In CrashPlan 3.6.3, the default maximum java heap size is 1024MB (it was
increased in the recent past from 512MB to 1024MB). However, sometimes that is not
enough. If this is the case for you, this script provides a method of updating the
maximum java heap size by editing this file and uncommenting #javaheap=4096 in
the beginning of the file and changing the value to whatever you need. I have 4GB
of RAM in my Synology NAS and a very large dataset, so I allow CrashPlan to consume
up to 4GB. The value is always specified in MB, but please ensure you provide
numbers only.
WARNING: If you're going to edit the script, please only edit the javaheap line at the top. If you edit the script on Windows, make sure you use an editor like Notepad++ (not Notepad) that will respect Linux EOL style.
Obviously, you will need to ensure your NAS has the physical memory available. Synology recommends you purchase your memory upgrade from them (of course), but you don't have to if you know what you're doing (or think you do :-) ). The Synology Wiki has a good article on user-reported compatible RAM modules here: http://forum.synology.com/wiki/index.php/User_Reported_Compatible_RAM_modules.
For more information on Out of Memory issues with CrashPlan, see http://support.code42.com/CrashPlan/Latest/Troubleshooting/CrashPlan_Runs_Out_Of_Memory_And_Crashes.
I have created a batch script to make remote management easy from Windows. Check out: https://github.com/Hossy/win-crashplan-uiswitcher
Copyright 2012-2017 Hossy
syno-cpinstallsh is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
syno-cpinstallsh is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with syno-cpinstallsh. If not, see http://www.gnu.org/licenses/.
- Added handling for max_user_watches
- Increased wait time for CrashPlan start-up
- Added /bin/cpio symbolic link creation
- Added CrashPlan Health Check script
- Added ipkg package validation
- Added sed handling for CrashPlan installer
- Improved CrashPlan running logic
- Fixed bug with calling ps in narrow terminal
- Added requirement for screen since nohup stopped working in DSM 4.3.
- Changed to using screen instead of nohup.
- Replaced human health check with automated health check. This script now verifies CrashPlan starts successfully.
- Changed to using Optware's init.d instead of Synology's init.d
- Added fix for CrashPlan's installer failing to download the JVM.
- Added output of new .ui_info GUID to facilitate remote connections.
- Fixed logic in
fixoptware.sh
- Fixed bug with CrashPlan run detection after failed auto-upgrade.
- Fixed bug with java heap replacement (wasn't working). Now uses perl instead of sed.
- Fixed bug in CrashPlan verification where script would not proceed if there was an error checking the status
- Fixed bug for checking if CrashPlan was running if init.d script was broken
- Changed java heap sed command to be dynamic with CrashPlan updates
- Changed/Grouped exit codes to make more sense
- Added java heap option at the top of the script to make it easier to use
- Added documentation in README for java heap setting
- Added comments to script
- Fixed java heap option (CrashPlan changed from 512MB to 1024MB by default)
- Added protection to stop CrashPlan before attempting to install
- Added removal of CrashPlan upgrade directory before installation (for cleanup)
- Added removal of CrashPlanDesktop symlink (for cleanup)
- Added removal of both old and new rc.d symlinks
- install.sh will recreate the non .sh one and then this script will rename it
- Fixes a bug where the rc.d script and init.d script were actual files and not symlink and file combo
- Replaced string substitutions with perl commands instead of sed
- .bak files are now created
- Starting and stopping CrashPlan is now done via the init.d script instead of rc.d
- Misc on-screen instruction updates
- Fixed java path logic
- Replaced die with exit
- Script now terminates if CrashPlan install fails
- Cleaned up comments
- Fixed PATH to prevent constant reinstall of java
- Fixed sed command for S99crashplan to prevent endless PATH entries
- Added ulimit to increase open files limit
- Added comment for adjusting java memory allocation (NOTE: Additional RAM required)
- Added PID display to netstat at the end
- Initial commit