aboutsummaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorJakob Unterwurzacher2015-12-20 18:17:06 +0100
committerJakob Unterwurzacher2015-12-20 18:17:06 +0100
commit0ebc0b7412d811b0865080573555100649a068fc (patch)
treeaf0e732abf52e34ec65e8f234a6b93ea92b1b4ca /docs/index.md
parentf419d49d65fc638fd15b603364b2e8e92609da91 (diff)
Add content, customize theme
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..755f510
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,32 @@
+gocryptfs - An encrypted filesystem written in Go
+=================================================
+
+gocryptfs uses file-based encryption that is implemented as a mountable
+FUSE filesystem.
+Each file in gocryptfs is stored one corresponding encrypted files on the hard disk. The
+screenshot below shows a mounted gocryptfs filesystem (left) and the
+encrypted files (right).
+
+The encrypted files can be stored in any folder on your hard disk, a USB
+stick or even inside the Dropbox folder. One advantage of file-based
+encryption as opposed to disk encryption is that encrypted files can
+be synchronised efficiently using standard tools like Dropbox or rsync.
+Also, the size of the encrypted filesystem is dynamic and only limited
+by the available disk space.
+
+![](img/folders-side-by-side.png)
+
+This project was inspired by EncFS and strives to fix its security
+issues while providing good performance.
+See the [Security](security) page for details on gocryptfs's cryptographic
+design.
+
+gocryptfs is a young project. While bugs in any software can cause issues,
+bugs in encryption software can cause catastrophic data loss. Keep a backup
+of your gocryptfs filesystem *and* store a copy of your master key (printed
+on mount) in a safe place.
+
+Only Linux is supported at the moment. Help is wanted for a Mac OS X port.
+Please contact me by filing an issue on the
+[github project](https://github.com/rfjakob/gocryptfs).
+