Note: This section applies only to FaunaDB Enterprise.
This document defines configurations within faunadb.yml and lists their defaults. It only covers configuration options required for basic administration.
Set the admin key for the cluster. Required to create databases or server keys, and must be set before a cluster can be initialized. Only one should be set.
faunadb-admin hash-key KEY command will create a hash of KEY that can be used in
auth_root_key to the key in plain-text OR use the
faunadb-admin hash-key KEY command to create a hash of KEY that can be used in
auth_root_key_hash. If you supply a key but no hash, FaunaDB will hash your key for you. If you supply a hash but no key, FaunaDB will use the hash. If you set both, FaunaDB will prefer the hash.
The ports that nodes use to communicate with each other. If peer-to-peer encryption is configured, nodes will first initiate an SSL-encrypted connection over the secure ports. If it is established that the two nodes are in the same datacenter, then the connection is switched over to the normal ports and encryption is dropped.
It is acceptable to open
network_peer_secure_port to the public internet.
network_peer_port is unsecured and should be protected by a firewall or equivalent mechanism.
Identifies the FaunaDB Enterprise cluster. Nodes with different cluster names will not connect with each other. Required.
Identifies the logical datacenter the node is in.
The identifier returned in the headers of requests to identify the coordinator of the request.
The primary network address that identifies the node to the cluster. This should be routable by any node within the cluster.
In an AWS cluster, this should be set to the node’s public IP.
|network_broadcast_address||IP address associated with the node’s hostname|
In a situation where
network_broadcast_address may not be set to the actual IP of the
node, this setting determines the interface FaunaDB should bind to and should be set
to the IP of the node.
It does not need to be routable by all nodes, but nodes within the same datacenter should be able to connect to it.
In an AWS cluster, this should be set to the node’s private IP.
|network_listen_address||IP address associated with the node|
Paths to log and data directories, respectively. These paths must exist and be writable by the FaunaDB service.
Snapshots are, by default, saved within the
storage_data_path, but you can specify another place to store them using
storage_temp_path lets you specify where FaunaDB will store its temporary files.
FaunaDB will create a several logs that can help during the debugging process. By default,
logging will be done at the INFO level, and we recommend leaving that alone when you are first getting started. However, the log level can be raised or lowered through the configuration file.
Logs can be disabled completely by setting
log_level to OFF.
You can specify the config file for the faunadb script using
faunadb_config. If nothing is specified, FaunaDB will look for the config in the usual places (./faunadb.yml, /usr/etc/faunadb.yml, /etc/faunadb.yml).