Sign inSign up

fauna/faunadb

By fauna

•Updated over 1 year ago

Fauna is the data API for modern applications.

Image
16

500K+

fauna/faunadb repository overview

⁠Quick reference

⁠Where to get help:
⁠Where to file issues:

Report them on the Fauna forums⁠

⁠Maintained by:

Fauna Inc.⁠

⁠Image updates:

Periodically as new versions of Fauna are released.

⁠Supported Docker versions:

The latest release (Docker 17.06.0-ce or higher)

⁠Documentation:

https://docs.fauna.com/fauna/current/integrations/dev⁠

⁠How to use

⁠Pull Docker Image

To get a docker image of Fauna, simply run: $ docker pull fauna/faunadb:<version> replace <version> with the Fauna version you'd like to use. latest will pull the latest release.

⁠Usage
$ docker run fauna/faunadb:<version> --help
Fauna Dev Docker Image

Options:
 --help                 Print this message and exit.
 --init                 Initialize the node (default action).
 --run                  Run and doesn't initialize the node.
 --join host[:port]     Join a cluster through an active node specified in host and port.
 --replica_name <name>  Specify a replica name for the node (default: "NoDC").
 --config <path>        Specify a custom config file. Should be accessible inside the docker image.

If you want a Fauna instance up and running, the simplest way to do it is by running:

$ docker run --rm --name fauna -p 8443:8443 -p 8084:8084 fauna/faunadb:<version>

This will expose the Fauna endpoint on port 8443 and the GraphQL endpoint on 8084.

⁠Persisted data

The above command will start a Fauna instance and initialise the cluster, however when you kill the docker container, all your data will be lost. In order to prevent this you can map a volume to the folder /var/lib/fauna and all data stored in Fauna can be persisted among executions.

$ docker run --rm --name fauna -p 8443:8443 -p 8084:8084 \
    -v <host-directory or named-volume>:/var/lib/fauna \
    fauna/faunadb:<version>
⁠Fauna logs

To access to Fauna logs, you can also map a volume to the folder /var/log/fauna

$ docker run --rm --name fauna -p 8443:8443 -p 8084:8084 \
    -v <host-directory or named-volume>:/var/lib/fauna \
    -v <host-directory>:/var/log/fauna \
    fauna/faunadb:<version>
⁠Fauna config

The previous command will start a Fauna instance using the default configurations. You can provide your own fauna.yml config by mapping it into the container and providing fauna the location by using the --config flag.

$ docker run --rm --name fauna -p 8443:8443 -p 8084:8084 \
    -v <host-directory or named-volume>:/var/lib/fauna \
    -v <host-directory>:/var/log/fauna \
    -v <path-to-config-file>:/etc/fauna.yml \
    fauna/faunadb:<version> --config /etc/fauna.yml

⁠Example Config

auth_root_key: secret
network_datacenter_name: NoDc
storage_data_path: /storage/data
log_path: /storage/log
shutdown_grace_period_seconds: 0
network_listen_address: 172.17.0.2
network_broadcast_address: 172.17.0.2
network_admin_http_address: 172.17.0.2
network_coordinator_http_address: 172.17.0.2
storage_transaction_log_nodes: - [ 172.17.0.2 ]
accelerate_indexes: true

⁠Licensing

Fauna is a fully managed SaaS service available at at https://fauna.com⁠. This image is meant to be used only for offline development, in concert with your account on fauna.com. Please review the License at https://www2.fauna.com/terms⁠ before you download this docker image.

⁠Questions?

Please contact us via http://www2.fauna.com/contact-us⁠

Tag summary

Content type

Image

Digest

sha256:a0617d2a2…

Size

318.6 MB

Last updated

over 1 year ago

docker pull fauna/faunadb