Table of Contents

Installing Facette

From Binaries

This is the preferred method. Binary releases and Linux distribution packages are available on the project releases page on Github.

From Docker Hub

We provide Docker images for every stable release, so you can try Facette without installing it on your system. Check out our repository for available images and usage instructions.

Alternatively, a Dockerfile is provided in the sources tree to allow you to build a Docker image from the tip of the sources repository (see “From Sources > Additional Targets” section of this page).

From Sources

To build Facette from the sources, you can either use a release tarball available on Github or retrieve the source code by cloning the Git repository:

git clone https://github.com/facette/facette.git

Build Requirements

Build Instructions

Note: if using the Debian/Ubuntu distribution-provided nodejs package, since the shipped binary is /usr/bin/nodejs instead of /usr/bin/node, you have to install nodejs-legacy as well for Facette Node.js dependencies to work.

At the top the sources directory, run the build command:

make install

By default Facette will be built in the tmp directory and installed in the build directory. To change the installation directory, set the PREFIX variable:

sudo make PREFIX=/path/to/directory install

Additional Targets

Run the various test suites

make test

Clean the building environment

make clean

Build a Docker image from the current sources tree

make docker

To change the image tag (default: facette-latest), set the DOCKER_TAG variable:

make DOCKER_TAG=my_company/facette:x.y.z docker