Fedora, FLOSS, Open Source Rocking

Version-controlled, automagical backup and file sharing system with Sparkleshare and Fedora


Photo credit: ardenswayoflife on Flickr, used under a CC-BY-SA 2.0 license.

The Burden of files

Okay, there’s a lot of problems:

  • Backing up your files is a pain in the butt.
  • Every time you upgrade your system, either in-place or a fresh install, it is a royal hassle to restore your files.
  • That file looks great on your laptop, but how do you show it to a colleague not sitting next to you easily? Ughh.
  • You upload files to a random directory on some web server you have some space on, quickly to show an idea to someone. Fast-forward some time, and you’ve got disorganized, poorly-named files scattered across multiple shell / other accounts all over the web, and you’re not sure what you have a copy of where, or which ones are being referred to from other places, so you’re terrified to delete any of them.
  • Well, crap. You’ve made a mistake. You can’t go back, can you? No version control…

I think we all know these problems pretty well. I’ve built a solution using Fedora and Sparkleshare – completely free and open source software – that over the past week has addressed all of these issues and has substantially improved the quality of my computing life. It backs my work files up to an internal corporate server and it backs my Fedora files up to a Fedora-maintained public server. I’m planning to configure it to back up some personal files to my Dreamhost account and some to my NAS at home.

What? What are you talking about?

Here’s how it works: I have a ‘Sparkleshare’ folder in my home directory. Under that, I have a couple of subfolders:

  • workstuff
  • design-team (this is for Fedora stuff)

When I start a project, say it’s for work, then I create a new subfolder under the appropriate directory. So I’m starting a new project, let’s say it’s a logo design for project X. I have the following directory tree:

~/SparkleShare/workstuff/logos/

I open up Inkscape, and start working on the logo. I work on it for a while. Now I’ve got a draft I’d like to save and show to a colleague. From within Inkscape, I navigate to the SparkleShare > workstuff > logos folder and save the logo there. Then I can go to my internal server, and automagically, the logo file I just saved is at http://hostname/workstuff/logos/mylogo.svg. I can quickly copy/paste that URL from my browser and send it via IRC or email to my colleague.

No uploading, no fumbling to find a server that has space in an appropriate location, no waiting for the upload to happen, no coming up with some lame variation of ‘temp’, ‘tmp’, ‘foobar’, ‘blah’ to make a fresh folder to upload it to. Nope. It’s just there.

Here’s how to set this up for yourself. :)

Setup Walkthrough

Ingredients

You will need:

Other assumptions:

  • I’m assuming you’re using GNOME. Sparkleshare does work on KDE or XFCE or LXDE. What you lose by not using GNOME is the nautilus right-click extension that lets you – from gitorious or github repos – check out older versions of a document or grab a web link to the document. Not a huge deal.

Step 1: Prepare your local system

We’re going to install Sparkleshare first.

  1. Open up a terminal.
  2. Go to the yum repositories directory:
    cd /etc/yum.repos.d
  3. As root, download Alex Hudson’s Sparkleshare Fedora people repo config:
     sudo curl -O http://repos.fedorapeople.org/repos/alexh/sparkleshare/fedora-sparkleshare.repo
  4. Install sparkleshare and openssh-askpass:
    sudo yum install -y sparkleshare openssh-askpass
  5. Remove nautilus-python (I don’t know why, but if you have this installed and install Sparkleshare, Nautilus will segfault on startup. If you remove it, though, everything works fine.)
    sudo yum remove -y nautilus-python

You now have Sparkleshare installed.

Step 2: Set up your main git repo

First you have to figure out where you want your main git repo to be. It needs to be in an account that your desktop/laptop can connect to. I set mine up in a remote home directory I own. Here’s how to do it:

  1. We’re going to create the empty new git repo. In your remote home directory, type
    git init --bare repo.git

    . (If this command doesn’t seem to work and you have permissions to do so, try installing openssh-server and updating git.)

  2. Now we’re going to make a dummy clone of the repo to add an initial file and branch. To make things more interesting, we’re going to do this in your public_html directory, but you can do it anywhere you’d like in your home directory:
    • Go into your public_html directory.
      cd ~/public_html
    • Clone it! Type
      git clone repo.git
    • Go into your new clone with
      cd repo
    • Now make a new dummy file,
      echo 'Fedora 15 rocks!' >> test.txt
    • Now commit it.
      git add test.txt; git commit test.txt -m 'initial commit2'
    • Push it, making your initial branch.
      git push origin master

Step 3: Hook your local system up to your repo

Okay, now we’re going to get your local system hooked up to the repo you just created on your remote system.
On your local laptop/desktop:

  1. Turn Sparkleshare on. Click on its icon in your Applications menu, or run it from the terminal:
    sparkleshare start
  2. Right-click on the Sparkleshare icon in your system tray, and select “Add Remote Folder…”
  3. Where Sparkleshare asks you: “Where is your remote folder?” select “On my own server.” In the field after “On my own server, replace my fake credentials here with your own, and don’t forget the ‘.git’ on the end.
    user@hellokitty.ponies.com
  4. Where Sparkleshare asks you for the “Folder name”, fill in something like this, replacing my directory structure with your own on the remote server:
    /home/user/repo.git
  5. Sparkleshare should say something about ‘coffee o’clock’ and it should start pulling the remote files down.
  6. Look in your Sparkleshare folder for the repo you just connected. Are the files from the server there?
  7. Now we’re going to make sure it’s set up right. Create a text file in your new Sparkleshare repo directory (will be somewhere like ‘/home/user/Sparkleshare/repo’).

Okay, that should have pushed up to the server, no issues. Make sure it did; On your remote system where git is:

  1. Go into your remote clone.
    cd ~/public_html/repo
  2. Pull down the changes!
    git pull
  3. Make sure the changes worked. You can either visit the web side of your clone at (replace with the relevant hostname and username) http://hellokitty.ponies.com/~user/repo or you can just cat it, making sure our new panda message is present:
    cat test.txt

All right, hopefully that wasn’t an issue either and your remote clone was able to pick up the panda PSA you pushed from your local laptop/desktop. Now we’re going to throw Sparkleshare into the mix.
On your local laptop/desktop where Sparkleshare is installed:

  1. Restart Sparkleshare. You can click on the icon or
    sparkleshare start
  2. Go to the Sparkleshare repo directory.
    cd ~/SparkleShare/repo
  3. Make a new test file. In honor of towel day today:
    echo '42' >> theanswer.txt

Let’s see if it worked!!!!! On your remote system:

  1. Go into the clone:
    cd ~/public_html/repo
  2. Pull it down!
    git pull

Did it work??? It worked for me!!

Step 4: Set up automagical web mirroring of your repo’s content

Okay, so I did a sneaky thing. Our remote repo, in the examples above, has been configured in your remote public_html directory on the same system your remote git repo is. Now, you could follow these directions on a third remote system if you’d like; no problem. Just make sure you’ve got your public SSH key configured on that third system and that you have access to write to a web-readable directory. These instructions should not be difficult to modify for that case; simply git clone your repo in a web-readable directory.

We are now going to hook this all up so that when you save a file on your local laptop/desktop, and SparkleShare checks it in, the web-readable clone of it all also automagically pulls down your change and makes the file available in a web browser. Woo!

On your remote system:

  1. Get into the hooks directory where your main (not clone) git repo is (don’t forget the .git!):
    cd ~/git.repo/hooks
  2. We’re gonna set up a hook so whenever you push a file to the repo, it tells the web clone to pull. Create a file called ‘post-receive’ in ~/git.repo/hooks with the following in it, replacing ‘user’ with your own username on the remote system:
    #!/bin/sh
    
    while read oldrev newrev refname
    do
    true
    done
    cd /home/user/public_html/repo
    GIT_DIR=/home/user/public_html/repo/.git git pull
    

Okay, let’s see if it worked.
On your local laptop/desktop where Sparkleshare is installed:

  1. Make sure Sparkleshare is running. If it’s not, start it.
    sparkleshare start
  2. Go into the right directory and make another test file.
    cd ~/SparkleShare/repo; echo 'Fedora 15' >> latestfedora.txt

Okay, moment of truth. Is your new test file in your web directory? Either visit (replacing the username and hostname of course) http://hellokitty.ponies.com/~user/repo and look for a file named latestfedora.txt (if it’s there, it worked!) or on the remote system:

  1. Go into the web-readable repo clone:
    cd ~/public_html/repo
  2. Look for the file.
    ls

It worked!!

What do you think?

So, what do you think? Pretty awesome, right? Goodbye, dropbox – a worthless solution when your corporate IT policy rightly frowns upon copying internal documents to third-party public servers. You can create as many repos like this as you like. You can host them on a remote server you have shell access to, as this tutorial assumed, or you can set it up on Gitorious (I recommend this one since it’s backed by free & open source sw) or Github. Or a Fedora Hosted repo if you’ve got one. Each repo will have a folder under your ‘SparkleShare’ folder in your home directory, and anything in that directory is basically remotely backed up, instantly, as soon as you save files in those directories (and given that Sparkleshare is running.)

We’re currently experimenting with using this setup for the Fedora Design team to hopefully make it easier for folks to access our files and contribute.

Some things you might want to consider with this setup

  • Set Sparkleshare to always run when your machine is booted. For GNOMEies:
    cp /usr/share/applications/sparkleshare.desktop ~/.config/autostart
  • Write down the remote git URLs of all of the remote repos your stuff is backed up to and keep it in a safe place. If disaster strikes and a panda mistakes your laptop for bamboo, it will make it that much easier to recover.


Major kudos

Discussion

28 thoughts on “Version-controlled, automagical backup and file sharing system with Sparkleshare and Fedora

  1. Sparkleshare have some good features, but a big problem: Mono. :(

    Posted by Para-Dox | May 25, 2011, 11:58 am
    • Certainly it’s better than Dropbox or Box.net or Ubuntu Cloud or any number of similar applications whose server-side is proprietary. Better mono than proprietary IMHO.

      Posted by mairin | May 25, 2011, 12:31 pm
      • Yes, you’re right, it’s better than a service with proprietary server. :D

        But Mono add some volontaries problems with patents. Sparkleshare should be port to Vala, but I think vala have some problem with some same patents because its syntax is based on C#.

        I don’t know why this project are not started in Python or C+GObject.

        Posted by Para-Dox | May 25, 2011, 12:36 pm
        • You know, Hylke is a pretty cool guy – I am sure he’s quite happy to take patches or any other help.

          Posted by mairin | May 25, 2011, 12:37 pm
        • The patents have nothing to do with syntax. If they did, then either Gosling, Stroustrup, Ritchie, or Richards would be the owner of all the relevant patents. :p

          The patents, if they are valid and exist at all, would be on language runtime implementation details. Many of these probably have no effect on Mono, either, as it is not implemented the same as upstream .NET (which is way faster than Mono, due to a significantly more advanced JIT compiler and runtime), and the ones that do affect Mono are just as likely to affect any implementation of any kind of any statically-typed register-based virtual-machine, which would pretty much mean the language design and development segment of the CS community is permanently fubar’d.

          So far as why not Python, there’s plenty of reasons. However, since it’s impossible to offer criticism of Python without a Python fanatic going off the deep-end and calling you a slightly retarded Java user, I’ll just say that “it’s probably a matter of personal preference” and leave it at that.

          So far as why not C+GObject, it’s probably because the authors value their sanity, and realize that it being 2011 means that they don’t have to pretend that C is still the ideal language for writing anything. And seriously, OOP in C is an abomination unto mankind. If we don’t curb our use of the GObject macro-hell soon, we may very well awaken Godzilla. True story. ;)

          Posted by Sean | May 26, 2011, 4:50 pm
    • IIUC the data is stored in a plain Git repo (or are there any Sparkleshare specific extensions?); so while the client software might be problematic, the data is in an open format. If you suddenly have to pay fees for using Mono, you can still extract your files with command-line git, or by writing a Sparkleshare replacement in your favorite language.

      IMO this makes Sparkleshare much less problematic than, say, F-Spot.

      Posted by oliver | May 27, 2011, 6:27 am
  2. Awesome article Máirín.

    The python/nautilus segfault problem should be vaguely worked out in the packages: it’s been removed from the Fedora 15 versions. Nautilus apparently expects its extensions to be python3, but pygtk is python2 – the two get mixed and it seems that hilarity ensues.

    I don’t know how I’m going to solve that any time soon, it might be that we have to wait for pygtk to catch up or something, not sure. But at any rate, that bug shouldn’t raise its head any more.

    I’m hoping we can also look at some seahorse integration or something to take more of the pain out of the keys and stuff.

    Posted by Alex Hudson | May 25, 2011, 12:35 pm
  3. This is the guide I’ve been waiting for! I’ve been longing to have my own sparkleshare server set up so I can sync my Desktop, Laptop, Wife’s Laptop, and DVR with my NAS Server.

    I use Dropbox for a few small things, but would love to just drop my /home in there and just forget about it.

    Thanks for the guide

    Posted by Ben Foote | May 25, 2011, 3:33 pm
  4. Thanks, this is really cool. I’ve wanted something like this for a long time. And it actually worked fine the first time I tried :) Thanks for taking the time to make such detailed instructions!

    Posted by Alon | May 25, 2011, 4:05 pm
  5. I think this is an really awesome piece from the full puzzle. I mean, if i would like to have exclusively different servers including cloud at home, mailing, file share, NAS, print server and so on – this is one of them that I would like to see between the apps. Indeed, it can be an awesome fedora remix if we collect services, that holds my privacy on my machine based on free open source GPL programs.

    Posted by zoltanh721 | May 25, 2011, 4:12 pm
  6. At least git has different error messages for different errors. <3
    Oh, and go spread the word to help me on my quest to make "Operation failed" error messages die!

    Posted by Benjamin Otte | May 25, 2011, 4:16 pm
  7. Nice article, but what a pity Sparkleshare is written in Mono.

    Pragmatism says accept the trojan horse, however if you are truly concerned about security and principles, the correct policy would be to keep looking for another alternative.

    In the short-term it’s hard, but in the long-term, it will be the best option. And I do hope the Red Hat and Fedora community can soon come up with a Mono-free alternative.

    Posted by Frank Daley | May 25, 2011, 8:00 pm
    • Cool.

      I think we have enough anti-Mono comments now; I’m going to filter them out starting now. Congrats for making the last one in. :)

      Posted by mairin | May 25, 2011, 8:07 pm
  8. I believe you also may agree that this is not a easy solution that can be happily implemented by a non-technical user. I have a better solution (imho) which is to use http://www.wuala.com

    How it works is, you store files on your computer and they get synchronized to the cloud. I know Dropbox also does this. But the big difference is, the files are Encrypted before they are synchronized to server. The encryption key is with you and it never leaves your machine. So you can be rest assured that others may read your contents.

    There is also a techtalk on google about wuala – http://www.youtube.com/watch?v=3xKZ4KGkQY8

    Posted by Sankar | May 26, 2011, 12:26 pm
    • The point here is that the solution documented here is 100% free and open source and you can deploy your own server wherever you want without handing your files over to some third party company, potentially signing over your rights to your own files via some strange implicit licensing agreements. Wuala is not free & open source software, so I have absolutely no interest in it.

      Thanks for the suggestion for others who might not be so picky’s benefit, though! :)

      Posted by mairin | May 26, 2011, 12:44 pm
      • > Thanks for the suggestion for others who might not be so picky’s benefit, though!

        Yes, I pasted for that reason.

        Regarding the open-ness aspect that you mentioned, I see my data just as I see my money. I should be able to access it whenever I want and it should not be refused to me when I want to reach it. But it is impossible for me to lock all my money in my house. So I have to trust a bank to make my life easy. In the same way, I am trusting some online providers to make my life easy.

        However, 99% of online vendors will have the capability to read my data. So I become choosy and not trust everyone. I trust only GMail and Wuala (because there is no cheaper alternative for such a huge high-available mailing system) The reason why I trust wuala is no one apart from me can read the data that I store with them. The way in which they get money is by paid accounts. I like this model (much like flickr).

        The prime reason why none of these online services will be having open-source as their prime product is because it will affect their revenue. Consider if wuala was open source, somebody like Facebook can just take their source and kill their service. We have shifted into a desktop/server applications paradigm to a cloud storage paradigm where open-source tools will play a big role (apache, ha, hadoop etc.) but the prime business running service will not be open-sourced. We may have to get used to it.

        I am not brain-washing you to start using wuala or some cloud servuce ;-) I am just trying to share my opinion on why open-ness may not matter more in cloud based services in the future (where the world is heading) :-)

        Posted by Sankar | May 26, 2011, 1:03 pm
        • > I am just trying to share my opinion on why open-ness may not matter more in cloud based services in the future (where the world is heading) :-)

          Sure, and I wasn’t really taking it any other way. Although to be fair, I don’t think ‘cloud’ is an excuse to sweep software freedom under the rug. You say that open sourcing cloud solutions is a bad idea because anybody can take it and undercut you – I don’t think it’s that simple. I don’t want my data (no matter what kind of data it is) locked into some particular cloud vendor’s proprietary way of doing things – be it their particular API or way of organizing things – and not have the option to take it and move it to wherever else I want. Only with standardization is the user going to have any chance of having a decent solution and the software of having any impetus to not suck.

          On the undercutting part, honestly, I am paying dreamhost right now to host my stuff. But I can take any of my things on Dreamhost in a heartbeat and move them anywhere else. I would very much prefer someone else to host and admin my stuff, since I don’t particularly enjoy doing it, but not at the cost of using proprietary software. Help me host open source server applications like Dreamhost does and admin them for me like they do, and I will gladly pay you whatever. (Oh, haha, this very blog is a good example, I’m using wordpress.com’s hosted service but WordPress is open source and I’m totally cool with that.)

          I had an absolutely awful experience with gmail back in 2003 which led me to be so paranoid, I would never trust them (good luck to you.)

          Posted by mairin | May 26, 2011, 1:16 pm
  9. Hey,

    This is great stuff but I am wondering if you have looked at how one can do automatic encryption at the client side before sending data across the network. I would love do automatic syncs to multiple servers but only if the data is encrypted transparently

    Posted by Rahul Sundaram | May 26, 2011, 5:42 pm
    • Hey Rahul, I haven’t tried it yet but I plan on experimenting with encryption when I set up my dreamhost backup. My thought is that you could do, client-side, git hooks for pre-push to encrypt and post-pull to decrypt… but I don’t know if it’d kill performance as to be useless. Also, it kills the web sharing aspect but you probably don’t care too much about that if you’re encrypting the data. :)

      Posted by mairin | May 26, 2011, 6:36 pm
      • I currently use deja-dup to encrypt the files I’m backing off to the cloud. It’s not realtime though

        Posted by hbt | May 27, 2011, 3:02 am
  10. Very nice Mairin. I’ve been running a system like this for many years now using Unison.

    It syncs all my computers. On the server I can just symlink files and folders that I want to share. So I’ve symlinked e.g. my “public” folder, but also some “private” folders, like in Documents/Projects/Lumiera/images/ symlinked so that I can share it directly.

    I’m not too fond of SparkleShare because dumping big files into Git just doesn’t sound all that nice. And well, unison is well proven technology and it Just Works(tm) and has for many years, so no use changing that. Also, it’s easy to set up once I wrote the script that I use.

    (Yes, it also has version “backups” (3 older versions of all files, when they change), and if you want instant-sync you can use incron to watch for FILE_CLOSE and run the script on that)

    Posted by Odin Hørthe Omdal / Velmont | May 27, 2011, 4:19 am
  11. Really nice software, indeed. Some problems I have with this, however:
    – doesn’t run on my RHEL5 workstation at work (not sure if it’s due to RHEL5 or due to the NFS home directory)
    – always connects to some public IRC channel on freenode on startup – WTF? Big no-go for usage at work

    Let’s hope these will be fixed in future versions… Or if not, well the software is at least an inspiration on how to make a Dropbox replacement :-)

    Posted by oliver | May 27, 2011, 6:35 am
  12. Hi ! Thanks a lot fot this how to ! I wrote a blog entrie today in french to explain this on my weblog : http://blog.silvyn.net/?post/2011/06/02/Sauvegarde-en-ligne-automatique-de-fichiers-avec-Sparkleshare-sous-Fedora

    It works very fine, even if Nautilus seems to be a little less speed.

    Best regards.

    Posted by Sylvain | June 2, 2011, 3:44 pm
    • Awesome, I’m glad you found it useful Sylvain! Thank you very much for providing instructions in French!

      Posted by mairin | June 2, 2011, 3:47 pm
  13. Just got it to work with Snow Leopard 10.6.7 and 10.6.8. I hope it helps.

    http://www.instructables.com/id/SparkleShare-for-OSX-a-Dropbox-alternative/

    Posted by nico | July 13, 2011, 4:11 pm

Trackbacks/Pingbacks

  1. Pingback: Version-controlled, automagical backup and file sharing system with Sparkleshare and FedoraMáirín Duffy | 9nd.pl - May 25, 2011

Follow

Get every new post delivered to your Inbox.

Join 60 other followers

%d bloggers like this: