37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
# [SparkleShare](https://www.sparkleshare.org/)
|
|
|
|
SparkleShare is a file sharing and collaboration app. It works just like Dropbox, and you can run it on your own server. It's available for Linux distributions, macOS, and Windows. [Support the project on Patreon](https://www.patreon.com/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.
|
|
|
|
|
|
## Setting up a host
|
|
|
|
SparkleShare uses the version control system [Git](https://git-scm.com/) 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](https://github.com/hbons/Dazzle) that does the hard work for you. If you need to manage a lot of projects and/or users it may be worth setting up a [GitLab](https://www.gitlabhq.com) instance.
|
|
|
|
|
|
## Free and Open Source
|
|
`SparkleShare` is Free and Open Source software and licensed under the [GNU General Public License version 3 or later](legal/License_for_SparkleShare.txt). You are welcome to change and redistribute it under certain conditions. Its library `Sparkles` is licensed under the [GNU Lesser General Public License version 3 or later](legal/License_for_Sparkles.txt).
|
|
|
|
|
|
## Compiling from source
|
|
|
|
[](https://travis-ci.org/hbons/SparkleShare)
|
|
|
|
Here are instructions to build SparkleShare on [Linux distributions](SparkleShare/Linux/README.md), [macOS](SparkleShare/Mac/README.md), and [Windows](SparkleShare/Windows/README.md). Make sure to have the `git` package installed when you're building on Linux.
|
|
|
|
|
|
## Useful links
|
|
[Official website](https://www.sparkleshare.org/), [Twitter](https://www.twitter.com/SparkleShare), [Wiki](https://www.github.com/hbons/SparkleShare/wiki), and [Source Code](https://www.github.com/hbons/SparkleShare). Join the chat: `#sparkleshare` on `irc.gnome.org`.
|
|
|
|
|
|
## Finally
|
|
|
|
Have fun, make awesome. :)
|
|
|