Skip to content

Linux

Installation

Requires at least Ubuntu 14.04 LTS or Debian 9.

  1. Install apt-transport-https

    sudo apt-get install apt-transport-https
    
  2. Add Enclave’s package signing key and repository to apt sources

    curl -fsSL https://packages.enclave.io/apt/enclave.stable.gpg | sudo apt-key add -
    curl -fsSL https://packages.enclave.io/apt/enclave.stable.list | sudo tee /etc/apt/sources.list.d/enclave.stable.list
    sudo apt-get update
    
  3. Install Enclave.

    sudo apt-get install enclave
    
  4. Enrol

    sudo enclave enrol
    
  5. Provide your Default Enrolment Key to complete the installation

Requires at least CentOS 7.6 or RHEL 7.

  1. Install Enclave using our quick-start script

    bash <(curl -Ss https://install.enclave.io/setup.sh)
    
  2. Provide your Default Enrolment Key to complete the installation

Requires at least Fedora 32.

  1. Install Enclave using our quick-start script

    bash <(curl -Ss https://install.enclave.io/setup.sh)
    
  2. Provide your Default Enrolment Key to complete the installation

Requires at least Amazon Linux 2018.03.

  1. Install Enclave using our quick-start script

    bash <(curl -Ss https://install.enclave.io/setup.sh)
    
  2. Provide your Default Enrolment Key to complete the installation

Requires at least Arch Linux 2020.08.01.

  1. Install Enclave using our quick-start script

    bash <(curl -Ss https://install.enclave.io/setup.sh)
    
  2. Provide your Default Enrolment Key to complete the installation

Requires at least Raspbian 10 (buster).

  1. Install apt-transport-https

    sudo apt-get install apt-transport-https
    
  2. Add Enclave’s package signing key and repository to apt sources

    curl -fsSL https://packages.enclave.io/apt/enclave.stable.gpg | sudo apt-key add -
    curl -fsSL https://packages.enclave.io/apt/enclave.stable.list | sudo tee /etc/apt/sources.list.d/enclave.stable.list
    sudo apt-get update
    
  3. Install Enclave.

    sudo apt-get install enclave
    
  4. Enrol

    sudo enclave enrol
    
  5. Provide your Default Enrolment Key to complete the installation

Unattended installation

Enclave supports unattended installations by setting the Enrolment Key in a specially named environment variable: ENCLAVE_ENROLMENT_KEY.

  1. Set the Enrolment Key you want to use as an environment variable

    $ export ENCLAVE_ENROLMENT_KEY=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    

  2. Enrol the system using enclave enrol. If you're using sudo don't forget to include the -E argument (also --preserve-env) to preserve environment variables.

    $ sudo -E enclave enrol
    

  3. Enclave will automatically enrol and daemonise as a background process.

Starting and stopping Enclave

The Enclave installer creates a lightweight supervisor service set to run at system start which is responsible for starting the Enclave fabric. The supervisor service exists to start, stop and restart Enclave fabric in the background as daemon child processes.

The supervisor service responds to the Enclave CLI verbs start and stop to control the Fabric.

Updating Enclave

Enclave is updated using the standard apt package manager. We suggest wrapping the apt-get install command with nohup (as shown) so that if the update is performed using via a connection established using Enclave, the upgrade operation is not aborted when the Enclave process is terminated and instead allowed to continue in the background.

sudo apt-get update && sudo nohup apt-get install --only-upgrade enclave

Upgrade to the latest version of Enclave by running our quick-start script.

bash <(curl -Ss https://install.enclave.io/setup.sh)

Uninstalling Enclave

Remove the Enclave package while leaving configuration files on the system.

sudo apt-get remove enclave

Remove the Enclave package and any configuration files (including private any keys generated during enrolment).

sudo apt-get purge enclave

Note: Enclave does not backup a system's private keys. Lost or deleted private keys are not recoverable. If a system's configuration and private keys are lost, to use that system with Enclave again it must be re-enrolled.

What to do if the install fails

If an install goes horribly wrong or is interrupted, try re-running the Enclave setup.sh script to restart the process. If your installation fails and you are unable to resolve the problem by retrying, please contact support@enclave.io.

For troubleshooting and errors, use the site search or visit our troubleshooting section to look for information about common error messages.