Downloads

flatpak remote-add flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install flathub org.sparkleshare.SparkleShare

How does it work?

SparkleShare creates a special folder on your computer. You can add remotely hosted folders (or "projects") to this folder. These projects will be automatically kept in sync with both the host and all of your peers when someone adds, removes or edits a file.

What's it good for?

SparkleShare was made to cover certain use cases, but doesn't handle every scenario well. To help you decide if SparkleShare is right for you, here's a few examples of what it does well and less well with smiley faces:

Great

• Frequently changing project files, like text, office documents, and images
• Tracking and syncing files edited by multiple people
• Reverting a file to any point in its history
• Preventing spying on your files on the server using encryption

Not so great

• Full computer backups
• Large binary files that change often, like video editing projects

For more information on usecases, read the wiki.

Setting up a host

SparkleShare uses the version control system Git under the hood, so setting up a host yourself is relatively easy. Using your own host gives you more privacy and control, as well as lots of cheap storage space and higher transfer speeds. We've made a simple script that does the hard work for you:

# Run all of the following commands as the root user on
# a Debian or Red Hat based Linux system
su

# Fetch the Dazzle script
curl https://raw.githubusercontent.com/hbons/Dazzle/master/dazzle.sh \
  --output /usr/bin/dazzle && chmod +x /usr/bin/dazzle

# Run the initial setup
dazzle setup

# Link SparkleShare clients using their Client ID found in the status menu
dazzle link

# Create a new project. Add as many as you need
dazzle create PROJECT_NAME

# Alternatively, create a new encrypted project
dazzle create-encrypted PROJECT_NAME

That's all there is to it. Since SparkleShare uses plain Git repositories, you can keep using all your favourite tools that work with it. For example, for more sophisticated hosting, including team management and access control, check out Gitlab.

If maintaining your own host isn't for you, there are also existing project hosting sites like Github or Bitbucket that are compatible with SparkleShare (keep in mind your projects will be public unless you're on a plan, respective Terms of Service agreements apply).

Why SparkleShare?

The idea of SparkleShare sprouted at the GNOME Usability Hackfest in London, where a couple of designers came to the conclusion that they didn't have a good (Open Source) collaboration tool to share their work (for more background, read “The one where the designers ask for a pony”). They didn't like how the good collaboration tools were proprietary, and that using them meant having to give up privacy, control and other rights. What they needed was something that they could run and control themselves, without having to depend on other companies.

Need help?

• Encountered a problem? Report it on GitHub
• Something else? Contact the project maintainer

Twitter

• @SparkleShare
• @hbons