Install CCF

Tip

The ccf-app-template repository can be used to quickly setup the environment necessary to build CCF apps.

Quickstart

CCF builds and runs on Linux. It is primarily developed and tested on Azure Linux 3.0. To build a CCF application, installing the ccf_devel RPM package is sufficient. This package contains the libraries and headers required to build CCF applications.

CCF releases are available on the GitHub repository release page. They can be installed as follows:

# Set CCF_VERSION to most recent LTS release
$ export CCF_VERSION=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/microsoft/CCF/releases/latest | sed 's/^.*ccf-//')
# Alternatively, set this manually, e.g.:
# export CCF_VERSION=7.0.0
$ wget https://github.com/microsoft/CCF/releases/download/ccf-${CCF_VERSION}/ccf_devel_${CCF_VERSION}_x86_64.rpm
$ sudo tdnf install ./ccf_devel_${CCF_VERSION}_x86_64.rpm

The following commands can be run to verify that CCF was installed successfully:

$ /opt/ccf/bin/js_generic --version
CCF host: ccf-<version>
Platform: SNP

$ /opt/ccf/bin/sandbox.sh
No package/app specified. Defaulting to installed JS logging app
Setting up Python environment...
Python environment successfully setup
[16:10:16.552] Starting 1 CCF node...
[16:10:23.349] Started CCF network with the following nodes:
[16:10:23.350]   Node [0] = https://127.0.0.1:8000
...

Note

Before version 7, CCF releases included custom binaries for each platform. So if you’re installing an older version, you may need to find the snp or virtual rpm in the release, and this would be installed to /opt/ccf_snp or /opt/ccf_virtual.

The CCF install notably contains:

  • A sample js_generic application built with CCF, which may be used to host JS applications

  • The cmake files required to build CCF applications

  • Header files and libraries to build CCF applications (under include/ and lib/)

  • A limited set of Python utilities to start a basic CCF service for local testing

  • Various utility scripts (see Running CCF Applications)

Uninstall

To remove an installation of CCF, run:

$ sudo tdnf remove ccf_devel

From Source

To build and install CCF from source, please see Build CCF from Source. The devcontainer is a good way to get started: Github codespace