.. image:: https://api.travis-ci.org/gridsync/gridsync.svg?branch=master :target: https://travis-ci.org/gridsync/gridsync .. image:: https://ci.appveyor.com/api/projects/status/li99vnfax895i8oy/branch/master?svg=true :target: https://ci.appveyor.com/project/crwood/gridsync
Gridsync aims to provide a cross-platform, graphical user interface for
Tahoe-LAFS_, the Least Authority File Store. It is intended to simplify the Tahoe-LAFS installation and configuration process and ultimately provide user-friendly mechanisms for common use-cases like backing up local files, synchronizing directories between devices, and sharing files and folders with other users across all major desktop platforms (GNU/Linux, macOS, and Windows). More broadly, Gridsync aims to duplicate most of the core functionality provided by other, proprietary "cloud" backup and synchronization services and utilities (such as Dropbox and BitTorrent Sync) but without demanding any sacrifice of the user's privacy or freedom -- and without requiring usage or knowledge of the command line. Accordingly, Gridsync is developed with the goal in mind of making secure cloud storage freely available to everyone, without exception, without added barriers, and regardless of one's operating system choice.
.. _Tahoe-LAFS: https://tahoe-lafs.org
Tahoe-LAFS already provides a number of highly desirable properties for secure file-storage: in addition to offering client-side encryption, it is decentralized, robust, free (as in both beer and speech), stable and mature, and written by a group of very talented developers. Unfortunately -- and despite all of its technical merits -- Tahoe-LAFS has a number of persistent usability issues which steepen its learning curve: its installation requires manual compilation from source on Windows and macOS, its configuration consists in hand-editing text files, its primary interface requires heavy command line usage, and many of its fundamental concepts (e.g., "dircap", "shares", "servers-of-happiness") are opaque to new users or otherwise demand additional reading of the project's extensive documentation. Accordingly, Tahoe-LAFS' userbase consists primarily in seasoned developers and system administrators; non-technical users are naturally excluded from enjoying Tahoe-LAFS's aforementioned advantages.
The Gridsync project intends to overcome some of Tahoe-LAFS's usability barriers by means of following features:
magic-wormholelibrary to provide human-pronounceable "
invite codes" for joining storage grids and sharing folders with other users.
Recovery Key_" subsystem allows connections and folders to be easily restored from a single file in the event of a disaster.
Tor support(experimental) -- Gridsync can tunnel outgoing connections through the
Toranonymity network, concealing users' network location from storage service providers and each other.
.. _magic-wormhole: http://magic-wormhole.io .. _invite codes: https://github.com/gridsync/gridsync/blob/master/docs/invite-codes.md .. _Recovery Key: https://github.com/gridsync/gridsync/blob/master/docs/recovery-keys.md .. _Tor support: https://github.com/gridsync/gridsync/blob/master/docs/tor-integration.md .. _Tor: https://torproject.org
.. [*] Tahoe-LAFS' "Magic Folder" functionality is not (yet) fully supported on macOS or other BSD-based operating systems and is presently marked as experimental.
Downloads for "stable" releases of Gridsync can be found on the project's
GitHub Releases page and include pre-built/binary distrubitions for all three major desktop platforms that have been compiled inside dedicated virtual machines on dedicated hardware. Users wishing to install these packages are strongly urged to
verify their signatures before running or, alternatively, to build/install Gridsync manually from source (see below).
.. _GitHub Releases page: https://github.com/gridsync/gridsync/releases .. _verify their signatures: https://github.com/gridsync/gridsync/blob/master/docs/verifying-signatures.md
To install and run Gridsync on GNU/Linux (64-bit only; supporting glibc 2.17 and above -- including Debian 9+, Ubuntu 16.04 LTS+, CentOS 7+, and Fedora 28+):
chmod +x Gridsync-Linux.AppImage)
.. _Gridsync-Linux.AppImage: https://github.com/gridsync/gridsync/releases .. _verify: https://github.com/gridsync/gridsync/blob/master/docs/verifying-signatures.md
To install and run Gridsync on macOS (64-bit only; supporting macOS 10.13 "High Sierra" and above):
.. _Gridsync-macOS.dmg: https://github.com/gridsync/gridsync/releases .. _verify: https://github.com/gridsync/gridsync/blob/master/docs/verifying-signatures.md
To install and run Gridsync on Windows (64-bit only; supporting Windows Server 2012R2, Windows 7 SP1, Windows 8.1, and Windows 10):
Alternatively, Windows users who do not wish to use the executable installer can download and verify
Gridsync-Windows.zip_, extract the enclosed "Gridsync" folder anywhere, and run
.. _Gridsync-Windows-setup.exe: https://github.com/gridsync/gridsync/releases .. _verify: https://github.com/gridsync/gridsync/blob/master/docs/verifying-signatures.md .. _Gridsync-Windows.zip: https://github.com/gridsync/gridsync/releases
Because Tahoe-LAFS has not yet been ported to python3, and because some GNU/Linux distributions might contain especially old versions of some dependencies, it is recommended to install and run Tahoe-LAFS and Gridsync inside their own virtual environments using updated dependencies from PyPI (ideally with hashes verified).
The following series of steps (run from the top level of the Gridsync source tree) should work on most Debian-based GNU/Linux distributions:
.. code-block:: shell-session
sudo apt-get install build-essential libffi-dev libssl-dev python python-dev python3 python3-dev virtualenv virtualenv --python=python2 ./venv2 ./venv2/bin/python -m pip install --upgrade setuptools pip ./venv2/bin/python -m pip install tahoe-lafs virtualenv --python=python3 ./venv3 ./venv3/bin/python -m pip install --upgrade setuptools pip ./venv3/bin/python -m pip install -r requirements/requirements-hashes.txt ./venv3/bin/python -m pip install . PATH=$PATH:./venv2/bin ./venv3/bin/gridsync
Users of other distributions and operating systems should modify the above steps as required (for example, by installing Xcode on macOS in addition to python -- or the dependencies listed at the top of
make.bat_ in the case of Windows).
Alternatively, users can use
PyInstaller_ to generate a more "portable" binary distribution of Gridsync and Tahoe-LAFS (suitable for running on other machines of the same platform) by installing the required dependencies and typing
make in the top-level of the source tree. This will create a standalone executable distribution of Gridsync and all of its dependencies (including a "frozen" python interpreter and Tahoe-LAFS), placing the resultant files/installers in the
.. _PyInstaller: http://www.pyinstaller.org/
Note, however, that PyInstaller-generated binaries are typically
not backward-compatible_; a PyInstaller executable that was built on a newer GNU/Linux distribution, for example (i.e., with a more recent version of
glibc) will not run on older distributions. Accordingly, if you intend to distribute Gridsync binaries for use on a wide range operating system versions, it is recommended that you build the application on as old of a system as is reasonable for a given platform (i.e., one which can build and run Gridsync but which still receives security updates). Presently, CentOS 7, macOS "Mojave" (10.14), and Windows Server 2012 R2 arguably constitute the most suitable candidates for GNU/Linux, macOS, and Windows build systems respectively (insofar as binaries generated on these systems will be forward-compatible with all others in that platform-category that are still supported upstream).
.. _not backward-compatible: https://pyinstaller.readthedocs.io/en/latest/usage.html#platform-specific-notes
To help facilitate the testing, building, and distribution of forward-compatible binaries -- as well as to enable a crude form of "cross-compilation" -- a custom
Vagrantfile has been provided inside the Gridsync source tree; users or developers with
VirtualBox installed [*] can automatically provision a complete Gridsync build environment that produces forward-compatible binaries via the following commands:
.. code-block:: shell-session
make vagrant-build-linux make vagrant-build-macos make vagrant-build-windows
These will download and configure a suitable virtual machine for the target platform (from the
public Vagrant Boxes catalog_), provision it with all required dependencies (such compilers/SDKs, python interpreters, X11 libraries, etc.), copy the Gridsync source code into the target VM, run the Gridsync test suite, and compile a final PyInstaller-generated binary package suitable for distribution (the result of which can be found in the
~/gridsync/dist directory of the guest VM).
.. _Vagrantfile: https://github.com/gridsync/gridsync/tree/master/Vagrantfile .. _Vagrant: https://www.vagrantup.com/ .. _VirtualBox: https://www.virtualbox.org/ .. _public Vagrant Boxes catalog: https://app.vagrantup.com/boxes/search
.. [*] Note that in order to get Vagrant/VirtualBox working properly, users of GNU/Linux may need to add the current user's name to the local "vboxusers" group, while users experiencing issues with Windows guests may need to install some combination of the
winrm-elevated Vagrant plugins (via the
vagrant plugin install winrm winrm-fs winrm-elevated command). For further assistance with installing, configuring, or using Vagrant and/or VirtualBox on your system, please consult the appropriate upstream documentation and/or help forums. In addition, please note that Gridsync project can make no guarantees about the security or safety of public Vagrant "Boxes"; please exercise appropriate caution when relying upon third-party software.
Unsigned binary distributions (currently tracking the
master branch) are also available from the
project buildbot's "artifacts" directory_. These packages, however, should not be considered trustworthy or reliable in any way and are made available only for testing purposes by developers. Please excercise appropriate caution when using these files (ideally by downloading and running them inside a disposable virtual machine).
.. _project buildbot's "artifacts" directory: https://buildbot.gridsync.io/artifacts/
While Gridsync ultimately aims to provide an easy-to-use frontend for users of Tahoe-LAFS, at present, its interface only supports a very limited subset of Tahoe-LAFS's underlying features and potential use-cases (namely, it provides simplified means for joining storage grids, creating and sharing "magic-folders," and receiving status updates and notifications pertaining to those processes). Accordingly, users should not (yet) expect Gridsync to provide a complete backup solution or to serve as a stand-in replacement for other tools with robust sharing and collaboration capabilities.
In addition, it should be noted that Tahoe-LAFS's "magic-folder" functionality itself is currently considered "experimental" and has a number of
known issues and limitations and
open development tickets.
.. _known issues and limitations: https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.12.1/frontends/magic-folder.html#known-issues-and-limitations-with-magic-folder .. _open development tickets: https://tahoe-lafs.org/trac/tahoe-lafs/search?q=magic-folder&noquickjump=1&ticket=on
Contributions of any sort (e.g., suggestions, criticisms, bug reports, pull requests) are welcome. Any persons interested in aiding the development of Gridsync are encouraged to do so by opening a
GitHub Issue or by contacting its primary developer:
Copyright (C) 2015-2020 Christopher R. Wood
This program is free software: you can redistribute it 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 program is 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, see http://www.gnu.org/licenses/.
The ongoing development of this project is made possible by the generous sponsorships provided by
Least Authority and