Checkin of initial version

README.md

@@ -0,0 +1,72 @@
+Crashplan scripts
+=================
+This repository contains the script(s) I use to ease the administration of
+Crashplan (an excellent free tool that I use to backup data remotely) I am
+publishing them here so that others may benefit from these as well. Use them
+freely and please let me know is you encounter any issues or require changes.
+
+The latest versions, documentation and bugtracker available on my
+[GitLab instance](https://gitlab.lindenaar.net/scripts/crashplan)
+
+Copyright (c) 2016 Frederik Lindenaar. free for distribution under the GNU
+License, see [below](#license)
+
+
+copy\_crashplan\_id
+-------------------
+Shell script to copy the Crashplan client connection key from a remote (e.g.
+headless) Crashplan instance and setup the local machine's Crashplan client to
+connect to it using port forwarding over an open SSH connection. This automates
+the steps described on [Using CrashPlan On A Headless Computer]
+(https://support.code42.com/CrashPlan/4/Configuring/Using_CrashPlan_On_A_Headless_Computer)
+on the Crashplan support website. This script works on Linux and OS X.
+
+With the generated configuration in place, the local Crashplan client will
+connect to the remote Crashplan service as long as an SSH port forwarding of
+port 4244 is in place. This port forwarding can be achieved with the following
+command:
+
+  ~~~
+  ssh -L 4244:127.0.0.1:4243 user@host
+  ~~~
+
+Configuration parameters (at the top of the script:
+
+  Parameter  | Description
+  -----------+---------------------------------------------------------------
+  HOST       | name of host to connect to (i.e. runnig the crashplan service)
+  USER       | userid to login to HOST (Leave blank for current user)
+  SRC_SYSTEM | System type of HOST, either Linux, Darwin, OSX or detect\*
+
+\* if `SRC_SYSTEM` is not set or detect, the script will autodetect by running
+   `uname -s` on `HOST` using an SSH connection. This works reliably ut is slow
+   and hence best only used in environments with mixed systems.
+
+These parameters can also be set throug the command line by calling the script
+like:
+
+`copy_crashplan_id` - use configured values of `HOST`, `USER` and `SRC_SYSTEM`,
+at least `HOST` must be configured for the mode work (obviously)
+
+`copy_crashplan_id user@host` - connect to `host` as `user`, use `SRC_SYSTEM`
+
+`copy_crashplan_id user@host machine_type` - set all parameters from cmdline
+
+I use this script to fetch the Crashplan connection key from my NAS (which is
+running the Crashplan service but headless) and administer Crashplan remotely.
+
+
+<a name="license">License</a>
+=============================
+This script, documentation and configuration examples are free software: you can
+redistribute 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.
+
+This script, documentation and configuration examples are 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
+this program.  If not, download it from <http://www.gnu.org/licenses/>.