Explain the kbfsfuse modes in the README. OK abieber@ (MAINTAINER).

This commit is contained in:
juanfra 2019-09-17 20:47:21 +00:00
parent 334f665f84
commit 01cf37760b
3 changed files with 18 additions and 6 deletions

View File

@ -1,4 +1,4 @@
# $OpenBSD: Makefile,v 1.22 2019/09/13 13:22:03 abieber Exp $
# $OpenBSD: Makefile,v 1.23 2019/09/17 20:47:21 juanfra Exp $
# go-ps only supports amd64 on OpenBSD
# ../vendor/github.com/keybase/go-ps/process.go:39: undefined: processes
@ -12,7 +12,7 @@ V = 4.3.2
GH_ACCOUNT = keybase
GH_PROJECT = client
GH_TAGNAME = v${V}
REVISION = 0
REVISION = 1
DISTNAME = keybase-${V}

View File

@ -7,3 +7,6 @@ twitter accounts.
Once you have proven various identities, it is easier for people to
verify that you are actually who you say you are. This gives some
confidence when sending / receiving signed or encrypted messages!
Keybase also offers personal and team chat, git repos and a remote filesystem.
Everything is encrypted end-to-end and tied to your personal account.

View File

@ -1,4 +1,4 @@
$OpenBSD: README,v 1.2 2019/07/12 17:54:38 juanfra Exp $
$OpenBSD: README,v 1.3 2019/09/17 20:47:21 juanfra Exp $
+-----------------------------------------------------------------------
| Running ${PKGSTEM} on OpenBSD
@ -12,8 +12,10 @@ to access to the most of the Keybase features. "keybase" is the main daemon and
you can control it with "keybase ctl".
KBFS is a distributed and encrypted filesystem. Also, it's used as a remote for
the encrypted git repos. You need to run "kbfsfuse" to enable the access to
KBFS. Despite the name the daemon will not use FUSE, so you can run it
the encrypted git repos. You need to run "kbfsfuse" to be able to use the
"keybase fs" commands to access the files on KBFS. The git remote helper can
work directly with the keybase daemon and it doesn't need the kbfsfuse daemon
running. Despite the name the daemon will not use FUSE, so you can run it
without root access.
The "kbfsfuse" daemon will wait until the keybase daemon is ready. You can
@ -21,7 +23,14 @@ start both in parallel without worrying about the order. Upstream uses these
commands to autostart the daemons (the logs are saved in ~/.cache/keybase):
- keybase --debug --use-default-log-file service --auto-forked
- kbfsfuse -debug -log-to-file
- kbfsfuse -debug -log-to-file -mode default
The default mode of KBFS uses part of the memory to speed up the access to the
most used files on KBFS. Upstream provides the mode "constrained" for systems
with limited resources which they use for phones but can work also on
computers. If KBFS is still consuming too much resources, try "memoryLimited".
It will use the minimal memory required to work but the access to files will be
slow.
Using the Keybase services requires an account on keybase.io. If you don't have
an account, use "keybase signup" to register a new account and "keybase login"