CrashPlan Linux release 2008
readme
Thank you for trying CrashPlan! Please send all support questions related to our linux release to support@crashplan.com. This document is intended for folks comfortable with the linux command line. You don't have to be an expert, but if the idea of typing green text into a black window scares you, close this window now!
System Requirements:
32 or 64 bit Java 1.5.07+ for service
32 bit Java 1.5.07+ or greater must be installed (for desktop)
You can verify java is installed correctly and meets our version requirements by typing:
java -version
You should see something like:
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_12-b04)
Java HotSpot(TM) 64-Bit Server VM (build 1.5.0_12-b04, mixed mode)
Installation:
Unzip our installer in the location of your choosing. This is the installer only. Where you choose to install the actual application will be decided by you when you run the installer.
cd /mypreferred/installer/location
tar -zxf CrashPlan_2008-mm-dd.tgz
Wondering where your preferred install location should be? If you're only intending on backing up your data in your home folder, go ahead and install it in your home folder. Backing up the entire system? Install it where your other optional software goes. This is typically in /opt/ or /usr/local/.
What is this stuff I just unzipped?
There are two parts to CrashPlan:
CrashPlanEngine
CrashPlanDesktop
The Engine is the service that does the actual work of backing up. If it's not running, you're not being backed up.
The Desktop is a GUI that allows you to easily configure the engine, display status, and conduct restores.
Install!
It is very important to install CrashPlanEngine using an account that has read permissions for (or access to) the files you want to back up. Are you only intending to backup your own directory? Then installing the software with your permissions is fine. Want to back up someone else's directory or system files? Make sure to install the engine as root.
First, go to the directory where you untarred the installer:
cd /mypreferred/installer/location
Then, install the software with the permissions you prefer:
Installing engine with your permissions:
./install.sh
Installing engine with root permissions:
sudo ./install.sh
You will be asked a series of questions about where to install the base software and the GUI executable. If you like the default suggestions, just hit Enter to accept them. If you prefer other choices, type in your own.
Once the installation is complete, the engine should automatically be running in the background, and you should be good to go.
Your first backup:
The gui client is always run with your permissions so go ahead and start it up after the engine is started:
/usr/local/bin/CrashPlanDesktop
That's it! Create an account in CrashPlan, configure backup file selection, and push start. You're all set. Please note you can quit the UI at any time. It's not actually doing the backup, it's only doing the configuration.
Captain's Log:
All kinds of useful information is in the crashplan/log folder. Files ending in .0 are newest, .1 oldest. Entriest older than .0 or .1 are thrown away.
history.log Summary log of what CrashPlanEngine has been up to
service.log A very detailed log of CrashPlanEngine's activities
backup_files.log A list of files that were backed up when they're backed up
restore_files.log A list of files that were restored and any problems encountered
Remote GUI Config of CrashPlan on a shell account:
What if you have a remote shell account on a box that has SSH access, but no X windows interface or GUI? We're going to show you how to attach your local desktop CrashPlan UI to the remote CrashPlanEngine on a remote box.
We'll do this by using SSH to forward local traffic to the GUI control port of the service on the remote machine.
Step 1. Install & start engine on host 1.2.3.4 (this is the far away text only server)
Step 2. Install CrashPlan on your local desktop. (Mac, Windows, Linux, doesn't matter)
Step 3. In the CrashPlan folder of your local install, there is a folder called "conf", edit the file called my.ui.properties. Add this as a new line at the bottom of the file and save it. Shut down the GUI, and add this as a new line at the bottom of the file and save it. (If you are running a CrashPlanPRO blue client, substitute 4283 for 4200 in the commands below.)
servicePort=4200
Step 4. We need to forward port 4200 locally to our remote server using SSH. Type this in terminal:
ssh -L 4200:localhost:4243 yourusername@1.2.3.4
Step 5. Run your CrashPlan UI. You're now connected to remote CrashPlanEngine and can configure it at will.
Step 6. (optional) Pointing your UI back to local crashplan. Edit the "my.ui.properties" and comment out the servicePort change by putting a "#" in front and saving it. That's it! Next time you use UI it will connect to your local CrashPlan again.
#servicePort=4200
FAQ:
What if I don't want to use the UI?
Most settings can be changed by editing the conf/my.service.xml. Make sure you restart the engine after making changes for them to take affect.
Can I restore without the UI?
No, not yet. It's on our to do list.
Is it a bad idea to run the CrashPlanEngine as root?
There are basic risks associated with it. These are the same as any service running as root. Because the engine is written in java, it is immune to buffer overflows, a common exploit for poorly written C code. You should be aware that any desktop client connecting has "writes" to select any file and back it up. Therefor, you should "require" authentication each time the UI is run. This is in the "settings/security" part of CrashPlan UI.
What ports does CrashPlan use?
OUTBOUND TCP 443 outbound to talk to our servers. (Account creation, dynamic dns, etc.)
LISTENING TCP 4242 when talking to another CrashPlan instance for backup
LISTENING TCP 4243 on localhost only. This is what the CrashPlanDesktop uses to talk to the CrashPlanBackupEngine. (4283 for CrashPlanPRO blue clients)
What if I don't want to depend on your server?
Run our CrashPlan PRO Server product. It's free and available at http://www.crashplan.com/business/download.vtl
Why doesn't it do XYZ?
Because you haven't sent an e-mail to support@crashplan.com requesting feature XYZ
What about my other questions?
Send us an e-mail at support@crashplan.com