burkemw3 / syncthingfuse

Mozilla Public License 2.0
69 stars 7 forks source link

SyncthingFUSE

SyncthingFUSE allows you to see all of the files in shared Syncthing folders, but only stores a fixed amount of data locally.

When you open a file, the contents are served from a local cache, if possible. If the contents are not in the cache, then SyncthingFUSE asks peers for the contents and adds them to the cache. If no peers are currently available for the file, then opening the file will fail.

This is particularly useful if you have a Syncthing device with a lot of data that you want access to, but don't have room for all of on a device. For example, you may have a large collection of photos on a desktop running Syncthing at home. Your laptop's hard drive may not be large enough to hold all of the photos. Running SyncthingFUSE on the laptop, you will see all of your photos. As you view the photos on your laptop, they'll be read from the local cache or pulled from home. The local cache will not grow larger than a fixed size, though.

SyncthingFUSE is available on OS X and Linux.

SynthingFUSE is currently read-only. You can browse and view files but cannot write or modify them. (Supporting writes appears possible, but no one has put in the development effort, yet.)

SyncthingFUSE is currently an early release. Since it's currently read-only, it poses a low threat to damaging your computer or Syncthing folders. There is some risk, however, and you assume all of that yourself.

Getting Started

SyncthingFUSE follows many patterns of Syncthing, so you should be familiar with it before starting. Additionally, SyncthingFUSE requires at least one device running Syncthing.

To get started, grab a release for your operating system, unzip it, and run it. When you start the syncthingfuse binary, it will set itself up with some defaults and start. (OSXFUSE may be required on OS X, if you don't have it already.)

By default, a configuration UI is available in a browser at http://127.0.0.1:8385 (If the default port is taken, check the output of the startup for the line API listening on). Upon visiting, you will see a UI similar (albeit uglier) to Syncthing. On the left are folders that are configured, and on the right are devices.

Add devices and folders through the UI and restart SyncthingFUSE for the changes to take effect. Folders have a default cache size of 512 MiB, configurable through the UI. You'll also need to add the SyncthingFUSE device to your Syncthing devices.

By default, a mount point called "SyncthingFUSE" will be created in your home directory. After SyncthingFUSE connects to other Syncthing devices, you will be able to browse folder contents through this mount point.

SyncthingFUSE will appear as "Syncing (0%)" when connected in Syncthing devices. This looks strange but is expected.

Syncthing Compatibility

Supports:

Does not support: