On-premise install with ZIP

This section describes how to complete the installation steps, started here, using a ZIP archive.

Ensure that Java 8 (or higher, Java 11 recommended) is installed before proceeding with these installation steps.

java - version
java version "1.8.0_201"
Java(TM) SE Runtime Environment (build 1.8.0_201-b09)
Java HotSpot(TM) 64-Bit Server VM (build 25.201-b09, mixed mode)

If you don’t see similar output on your machine, see Oracle’s web site for Java JDK downloads.

  1. Download the ZIP archive:

    Click the Zip package button.

  2. Use a terminal to unpack the ZIP archive:

    unzip <download folder>/faunadb-enterprise-2.7.0-0.zip
    cd faunadb-2.7.0
    If you have downloaded a version of FaunaDB that is newer than these instructions, update the version number in the above commands before executing them.
  3. Create storage folders:

    mkdir -p ./storage/data ./storage/log
  4. Create a configuration file:

    Copy the following YAML configuration into the file ./etc/faunadb.yml:

    ---
    auth_root_key: secret
    cluster_name: fauna
    replica_name: replica
    storage_data_path: ./storage/data
    log_path: ./storage/log
    network_listen_address: 127.0.0.1
    network_broadcast_address: 127.0.0.1
    network_admin_http_address: 127.0.0.1
    network_coordinator_http_address: 127.0.0.1
  5. Start a node:

    ./bin/faunadb
    
    FaunaDB Enterprise Edition 2.7.0
    ================================
    Starting...
    Loaded configuration from faunadb-2.7.0/./etc/faunadb.yml...
    Network Host ID: 127.0.0.1
    Cluster name: fauna
    Data path: ./storage/data
    Temp path: ./storage/data/tmp
    Snapshot path: ./storage/data/snapshots
    Admin endpoint: 127.0.0.1:8444
    API endpoint: 127.0.0.1:8443
    FaunaDB is ready.

    If you see output similar to the above, FaunaDB has started successfully and is using the configuration that we specified.

    If this is the first time that you are running FaunaDB, internal data structures need to be initialized with the following command:

    faunadb-admin init
    
    Loaded configuration from faunadb-2.7.0/./etc/faunadb.yml...
    Node has initialized the cluster.
  6. Confirm that the node is running:

    curl http://172.17.0.2:8443/ping
    { "resource": "Scope write is OK" }
Single nodes, for development or testing, are free to use indefinitely. Clusters involving 2 or more nodes are free to use for 90 days. For more information, see our Pricing page.

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve! documentation@fauna.com

Thank you for your feedback!