Sunday, August 10, 2014

Building a RaspberryPi Time Capsule: The cheap, fast and simple guide


I am a longtime fan of Apples "Timemachine" data backup software. Having used multiple flavours of backup software on Linux and Windows, Timemachine has been by far the simplest and easiest one to use. In its simplest form, you only need to plug in a bog-standard hard drive into your Macbook to save your backups. But what if you couldn't even be bothered plugging in a USB drive? Is there a way to do it wirelessly? Good news! Apple sell a wireless backup solution, the "Time Capsule". The bad news? Its $350. There is, however, a cheaper solution.



Since the Raspberry Pi hobbyist development board came out, there have been many guides written on how to convert it into an Apple Timemachine compatible device. Although they work, I have found them to be overly complicated for what has to be done. Also, they require that the Raspberry Pi has a static IP, something that is inconvenient if you want to set up your backup on a new network when you move house, for example. Thankfully, I found one guide that offered a simpler solution. This guide removed much of the un-needed steps from the previous guides. This guide does require that you do the first preliminary backup over the network. For me, with over 300Gb of data to backup, this would have taken over 24 hours to transfer. It is much faster to do the preliminary backup over USB. As such, I have merged the two guides above into one, cheap, fast and simple Raspberry Pi - Time Capsule guide. 

Parts list

Required 

  1. SD card
  2. Raspberry Pi
  3. 3.5mm Portable Harddrive 

Optional 

  1. USB Wifi dongle 
  2. Philips screwdriver
  3. Sharp blade
  4. Mini USB cable 
  5. Soldering iron and solder

Setting up the Hard drive 

  1. Plug your USB into your Macbook. 
  2. Click on Applications - System Preferences - Time Machine. 
  3. Tell Time Machine which drive to use for backups by clicking the “Select Backup Disk…” button, selecting your newly plugged in drive, then clicking the “Use for Backup” button. 
  4. Time Machine will schedule your first backup to start in just two minutes. You will have to wait a while, as this can take a few hours. 
  5. Unplug the hard drive when done. 

Setting up and configuring the Raspberry Pi 

  1. Download the latest "Raspbian" OS image file for the Raspberry Pi. Dont download the "NOOB" version, as this will require that you use a TV to set it up. We will be using SSH in this guide. 
  2. Burn the OS image to the Raspberry Pi. If you are using OSX, use "RPi Easy SD card setup" app. This will take about 20min. Dont worry if you get an error saying "Could not eject card" at the end. It should have completed successfully. 
  3. Put the SD card in the Raspberry Pi. Connect an ethernet cable from the Raspberry Pi to your router. Power up the Raspberry Pi. 
  4. Log into your router on your internet browser and get the IP address of the Raspberry Pi. You can also get this using a TV connected to the Raspberry Pi. 
  5. Open a terminal in OSX, and ssh into the raspberry Pi. The password is "raspberry"
    $ssh pi@THEIPADDRESS 
  6. Update software on the device
    $sudo apt-get update 
    $sudo apt-get upgrade 
  7. Install the software that we will need. Netatalk is used for creating NFS shares, the others are used for reading the HFS formatted USB drive
    $sudo apt-get install netatalk 
    $sudo apt-get install hfsplus hfsutils hfsprogs 
  8. Edit the fstab file to automatically mount the usb drive on boot up
    $sudo nano /etc/fstab 
  9. Add the following lines, then ctrl + c to save and exit. Note: "sda2" was the partition on my USB drive that needed to be mounted. Yours may be sda1. Run "dmesg" to see which one you will have to mount. 
    /dev/sda2 /mnt/TimeMachine hfsplus rw,force,exec,auto,users 0 3
  10. Open up the permissions of the mount directory
    $sudo chmod 777 /mnt/TimeMachine
  11. Attempt to mount the usb drive:
    $sudo mount /dev/sda1 
    If it mounted successfully, try and write to the USB drive using "mkdir /mnt/Timemachine/testDir". Note: if you reboot the Raspberry Pi and the line in the fstab is not correct, the raspberry Pi will not boot up properly again. The easiest way to recover will be to write a new raspbian image to it. Also use the mount command to check that /dev/sda2 is mapped to /mnt/TimeMachine. Make sure that the letters rw are in the same result. This ensures that we have read/write access to the partition.
  12. Add the directory to the "Pi" user (the user that you will be logging in from your macbook with)
    $sudo chown -R pi /mnt/TimeMachine 
  13. Edit the Netatalk config file to share the Timemachine directory
    $sudo nano /etc/netatalk/AppleVolumes.default 
    Add the following line to the end, save and exit.
    /mnt/TimeMachine "Time Machine" options:tm 
  14. Restart netatalk
    $sudo service netatalk restart 
  15. Back on your macbook, a share called "raspberrypi" should appear on the left side of your finder window. If not, in finder, click on Go - Connect to server and type "afp://raspberrypi" or "afp://IPADDRESSOFRASPBERRYPI" into the address window. After you press enter, the shared directory should appear.
  16. Go into Timemachine again. Remove the previous backup disk. Click on "select disk" and select the raspberry Pi. It will prompt your for a username and password. Use "pi" for the username and "raspberry" for the password.
  17. Thats it! The macbook should recognise the previous backup and continue from there. After the previous backup over USB, the second backup over wireless should be alot faster.

Enabling wireless on the RaspberryPi Time Capsule (optional)

You can remove the requirement of having an ethernet cable between the router and the Raspberry Pi by plugging in a small usb wifi dongle into the Raspberry Pi and configuring the wireless. I used a Ralink RT5370 from ebay for this. To connect your Raspberry Pi to the wireless network, here are the steps.

  1. SSH into the Raspberry Pi over ethernet (see above). 
  2. Install the WPA wireless tools
    sudo apt-get install wpasupplicant wireless-tools 
  3. Edit the networking file to use the wpa-supplicant file for wireless configuration
    sudo nano /etc/network/interfaces
    Ensure the wlan0 section uses the following lines:
    allow-hotplug wlan0
    iface wlan0 inet manual
    wpa-roam /etc/wpa_supplicant/wpa_supplicant.conf
    iface default inet dhcp
    
  4. Edit the wpa-supplicant file
    sudo nano /etc/wpa_supplicant/wpa_supplicant.conf
    Ensure that it has the following lines
    ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
    update_config=1
    
    network={
            ssid="YourSSID"
            psk="password"
            key_mgmt=WPA-PSK
    }
    
    
  5. Save the file, disconnect the ethernet cable, and reboot the Raspberry Pi. It should now connect to the wireless network.

Powering the Raspberry Pi off the hard drive (optional)

I did not want to have to have a separate power supply for the hard drive and the Raspberry Pi as both would be kept together at all times. As such, I looked into powering the Raspberry Pi off the supply of the hard drive. 
  1. Using a sharp knife, cut the male, full size usb connector off your mini usb cable, exposing the four wires. 
  2. Tape up the two data lines, we wont need them and we dont want them touching anything. They are normally the green and white wires. 
  3. Expose around 2mm of the conductor from the 5v (red) and ground (black) wires. Tin them with solder and the soldering iron. 
  4. Dismantle your portable hard drive. Each one will be different. For mine, I had to remove 4 screws from the underside, and slide out the harddrive and controller from one end.  
  5. Look for the four wires going from the controller to the hard drive. There should be two black, one yellow and one red. We are looking for the 5v wire (red) and either of the ground wires (black). Solder the red and black wires from the USB cable to the points on the controller board that the corresponding hard drive wires are soldered to. 
  6. Find a way to route the cable out of the portable hard drive caddy. I drilled a small hole with the screwdriver and pulled the usb cable through it. I also tied a knot in the cable on the end inside the caddy so that it would not get pulled out through the hole if it was tugged on. 
  7. Put everything back together, power up the portable hard drive, and plug in the Raspberry Pi. The raspberry Pi should power up successfully. 

4 comments:

  1. This comment has been removed by a blog administrator.

    ReplyDelete
  2. Looks like a great guide to me, still waiting for files to download. If it doesn't work I'll let you know. Thanks in advance!

    ReplyDelete
  3. Thanks for this guide, very informative.

    One correction:
    --> at step 9 "/dev/sda2 /mnt/TimeMachine hfsplus rw,force,exec,auto,users 0 3" should be "/dev/sda2 /mnt/TimeMachine hfsplus rw,force,exec,auto,users 0 0" (last 3 should be 0). sudo mount -a will otherwise return with an error and after reboot the Raspberry Pi will not come up again and this will take you back to step 2.

    Thanks

    Aart

    ReplyDelete
  4. I've done these steps about 5 or six times from top to bottom and when I try to back up via the Raspberry Pi, I get "The backup disk image '/Volumes/Time Machine/Tim's Macbook Air.sparsebundle' could not be created (error (null))."

    When I plug in via the USB cable I don't have any problems with the back up. I even made the change AartJ said to step 9. I can create a directory on the USB drive from the Mac once it is connected as a server and I can see it when I'm ssh'd into the Pi. I'm not sure where I'm going wrong. If I figure it out, I'll post a fix here.

    ReplyDelete