This repository contains the official Keybase implementation of the client-side code for the Keybase filesystem (KBFS). See the KBFS documentation for an introduction and overview.
All code is written in the Go Language, and relies on the Keybase service.
This client allows you to mount KBFS as a proper filesystem at some
mountpoint on your local device (by default, /keybase/). It
communicates locally with the Keybase service, and remotely with three
types of KBFS servers (block servers, metadata servers, and key
servers).
The code is organized as follows:
- dokan: Helper code for running Dokan filesystems on Windows.
- kbfs: A thin command line utility for interacting with KBFS without using a filesystem mountpoint.
- kbfsdokan: The main executable for running KBFS on Windows.
- kbfsfuse: The main executable for running KBFS on Linux and OS X.
- libdokan: Library code gluing together KBFS and the Dokan protocol.
- libfs: Common library code useful to any filesystem presentation layer for KBFS.
- libfuse: Library code gluing together KBFS and the FUSE protocol.
- libkbfs: The core logic for KBFS.
- metricsutil: Helper code for collecting metrics.
- test: A test harness with a domain-specific test language and tests in that language.
- vendor: Vendored versions of the open-source libraries used by KBFS.
KBFS currently works on both Linux (at least Debian, Ubuntu and Arch), OS X, and Windows. It is approaching release ready, though currently it is still in alpha. There may still be bugs, so please keep backups of any important data you store in KBFS. Currently our pre-built packages are available by invitation only.
KBFS depends in part on the following awesome technologies to present a mountpoint on your device:
- FUSE (on Linux)
- FUSE for OS X (on OS X)
- Dokany (on Windows)
See our vendor directory for a complete list of open source packages KBFS uses.
Currently, our server implementations are not open source.
Prerequisites:
- Go 1.6 or higher.
- A running Keybase client service (see instructions).
- On OS X, you may have to install FUSE yourself.
- You may need to pass the
--use-system-fuseflag tokbfsfuseif you install FUSE yourself.
- You may need to pass the
- Then, mount KBFS at
/keybase/as follows:
cd kbfsfuse
go install
mkdir -p /keybase && sudo chown $USER /keybase
KEYBASE_RUN_MODE=prod kbfsfuse /keybaseNote that our pre-built packages for OS X include a branded version of FUSE for OS X, to ensure that it doesn't conflict with other local FUSE installations. It is still open source -- see here to see how we build it.
See our kbfsdokan documentation.
kbfsfuse -server-in-memory -localuser strib /keybase(Use "-server-root <dir> if instead you want to save your data to
local disk.)
Now you can do cool stuff like:
ls /keybase/private/strib
echo blahblah > /keybase/private/strib/foo
ls /keybase/private/strib,max(Note that "localuser" mode has only four hard-coded users to play with: "strib", "max", "chris", and "fred".)
We require all code to pass gofmt and govet. You can install our
precommit hooks to make sure your code passes gofmt and govet:
go get golang.org/x/tools/cmd/vet
ln -s $GOPATH/src/github.com/keybase/client/git-hooks/pre-commit $GOPATH/src/github.com/keybase/kbfs/.git/hooks/pre-commitThough it doesn't happen automatically, we also expect your code to be as "lint-free" as possible. Running golint is easy from the top-level kbfs directory:
go get -u github.com/golang/lint/golint
make lintKBFS vendors all of its dependencies into the local vendor
directory. To add or update dependencies, use the govendor tool, as
follows:
go install github.com/kardianos/govendor
govendor add github.com/foo/bar # or `govendor update`
git add --all vendorFrom kbfs/:
go test -i ./...
go test ./...If you change anything in interfaces.go, you will have to regenerate the mock interfaces used by the tests:
cd libkbfs
./gen_mocks.sh(Right now the mocks are checked into the repo; this isn't ideal and we should probably change it.)
Most code is released under the New BSD (3 Clause) License. If subdirectories include a different license, that license applies instead. (Specifically, dokan/dokan_header and most subdirectories in vendor are released under their own licenses.)