Environment Variables
ZefHub connections
ZEFHUB_AUTH_KEY
: eitherGUEST
to authenticate as a guest user or an API
key. See ZefDoc - ZefHub Authentication for more information.ZEFHUB_URL
: the URL to connect to, by defaultwss://hub.zefhub.io
.
Information messages
These variables match to ZefDoc - Runtime Config]
ZEFDB_QUIET
: changes the defaultzwitch
output options to bezefhub_communication_output(False)
,extra_quiet(True)
,graph_event_output(False)
.ZEFDB_VERBOSE
: changes the defaultzwitch
output options to bezefhub_communication_output(True)
,graph_event_output(True)
andextra_quiet(False)
.ZEFDB_DEVELOPER_ZEFHUB_JSON
: turns on thezwitch
optiondebug_zefhub_json_output
.ZEFDB_DEVELOPER_OUTPUT
: turns on thezwitch
optionsdebug_times
,zefhub_communication_output
,graph_event_output
anddeveloper_output
.ZEFDB_DEVELOPER_EARLY_TOKENS
: records anyET
/RT
/EN
/KW
tokens created
before the python module is fully loaded. This helps in identifying "core"
tokens that are required for the loading of the module which are missing from
the public set of ZefHub tokens.
Local storage
ZEFDB_FILEGRAPH_PATH
: where to store file-graphs, the caches for the zef graphsZEFDB_MEMORY_STYLE
: set toANONYMOUS
: for mmap-ed in-memory graphs without file backing.FILE_BACKED
: for mmap-ed in-memory graphs with cached file backing, seeZEFDB_FILEGRAPH_PATH
.- blank: for automatic choice. This is currently,
ANONYMOUS
for local graphs andFILE_BACKED
for graphs accessed from ZefHub.
Core behavior
ZEFDB_OFFLINE_MODE
: runs the butler in offline mode. You can't sync graphs
or otherwise communicate with ZefHub in this mode. Currently, it is not
possible to persist graphs locally in this mode either. You can createET
/RT
/EN
/KW
tokens in this mode, although they will be assigned
temporary values and won't persist beyond your python session.ZEFDB_TRANSFER_CHUNK_SIZE
: influences the transfer of large graphs.
Currently a bandaid on the websocket protocol, will be removed in the future.
Config
ZEFDB_SESSION_PATH
: the location of the directory where the config file is
stored. Defaults to$HOME/.zef
. The config file itself is located atZEFDB_SESSION_PATH/config.yaml
.
The following variables match to configuration options that can be modified through the
config
ZefOp. The variables will be merely listed here, see ZefDoc - Runtime Config for more
details about their behavior.
ZEFDB_LOGIN_AUTOCONNECT
ZEFDB_BUTLER_AUTOSTART
ZEFHUB_URL
ZEFDB_TOKENS_CACHE_PATH