rfjakob / gocryptfs-website

https://nuetzlich.net/gocryptfs
MIT License
16 stars 10 forks source link

Add note to quickstart about file sync conflicts #5

Closed taysu closed 5 years ago

taysu commented 6 years ago

Something I came across recently was how Seafile handles conflict resolution, and how it's not immediately obvious on mounted gocryptfs file systems if a conflict file has been generated. I came across this comment:

https://github.com/rfjakob/gocryptfs/issues/14#issuecomment-168837686

Which suggests enabling -plaintextnames when you initialize the file system if you intend to synchronize it with tools like Dropbox/Seafile.

I thought it would make sense to add a note to the quickstart section so that users are aware of this at the initialization stage. I'm using the Markdown admonition plugin for the note formatting, so I've enabled it in mkdocs.yml. Here is what it looks like rendered:

screenshot-2018-2-2 quickstart - gocryptfs

I've tried to keep it short so that the quickstart section stays quick, but I was thinking of adding another page/section which explains the problem in more detail (essentially that the conflict files Dropbox or similar tools create are invisible on the mounted file system). I'm sure there are some users who would choose to still use file name encryption and accept the conflict file problem as a trade off.

rfjakob commented 6 years ago

Hmm, not sure about this. I'd rather have an extra page explaining the problem and the tradeoff you get with disabling file name encryption. And a short note on Quickstart that points users to that page.

rfjakob commented 6 years ago

Something like

If you want to syncronize this filesystem across multiple devices by using file synchronization software like Dropbox or Seafile, you may want to use -plaintextnames for easier conflict resolutions - see page XYZ for details and the privacy tradeoff.

rfjakob commented 5 years ago

Closing for inactivity