summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Release-Tarballs.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/Release-Tarballs.md b/Release-Tarballs.md
new file mode 100644
index 0000000..e7eca7c
--- /dev/null
+++ b/Release-Tarballs.md
@@ -0,0 +1,33 @@
+This page describes the release tarballs that are published on https://github.com/rfjakob/gocryptfs/releases .
+
+## What files are available for download?
+
+| File | Contains |
+| --- | --- |
+| `gocryptfs_vX.Y.Z_linux-static_amd64.tar.gz` | Linux x86_64 binaries and manpages, compatible with all distributions |
+| `gocryptfs_vX.Y.Z_src.tar.gz` | gocryptfs source code |
+| `gocryptfs_vX.Y.Z_src-deps.tar.gz` | gocryptfs source code plus all dependencies (in the `vendor` dir) |
+| `*.asc` | gpg file signature ([how to verify](https://nuetzlich.net/gocryptfs/releases/#verify-binaries)) |
+
+If you want to immediately use `gocryptfs` on a Linux x86_64 PC, download the "linux-static_amd64" tarball.
+
+## What's inside the "linux-static_amd64" tarball?
+
+| File | Description |
+| --- | --- |
+| `gocryptfs` | gocryptfs binary compiled for Linux x86_64 |
+| `gocryptfs.1` | gocryptfs manpage |
+| `gocryptfs-xray` | gocryptfs-xray binary compiled for Linux x86_64 |
+| `gocryptfs-xray.1` | gocryptfs-xray manpage |
+
+Usually, you only need the `gocryptfs` binary.
+
+`gocryptfs-xray` can be used to extract the master key and encrypt or decrypt paths ([manpage](https://github.com/rfjakob/gocryptfs/blob/master/Documentation/MANPAGE-XRAY.md)).
+
+## Where is the changelog?
+
+Changelog is here: https://github.com/rfjakob/gocryptfs#changelog
+
+## Download Statistics
+
+Can be seen here: https://jessedp.github.io/github-release-stats/?username=rfjakob&repository=gocryptfs \ No newline at end of file