Installation¶
In this quick start guide we will start your journey with Enclave by showing you how to enrol your first two systems and use policy and tags to establish a private network between them.
Prerequisites¶
To follow this guide, you will need:
-
An Enclave account, it's free to register
-
At least two computers, devices or containers where you can install software
Get an Enrolment Key¶
You will need an Enrolment Key from your account to install Enclave. Enrolment Keys allow you to enrol new systems or devices to your Enclave account.
-
Login to your account in the Enclave Portal
-
Navigate to the Enrolment Keys page and select the
Quick Start Key
from the table -
In the details pane, select
View key
and make a note of the 30 character Enrolment Key
Security
Enrolment keys should be treated as secrets; handle, share and store your Enrolment Keys as you would any other organisational secret.
Production use
This guide uses a Quick Start Key
which was automatically created when you first registered for an account. This key by default is limited to 5 uses. You can (and should) create your own Enrolment Keys for use in production. Visit the Enrolment Keys section of the handbook to learn more about creating and managing Enrolment Keys.
Install Enclave¶
You will need to install Enclave on at least two separate devices, systems or containers.
Requires Windows 7, 8, 10 or Windows Server 2012, 2016 and 2019 (any edition). Packages are available for the x64 architecture.
-
Download and run the latest Windows installer
Want to deploy Enclave automatically via Group Policy or Configuration Manager? Check our docs on unattended installation for details.
-
Provide the
Quick Start Key
from your account to complete the installation
Requires at least OSX 10.10 (Yosemite).
-
Install the Homebrew Package Manager if you don't already have it
-
Install Enclave, you will likely be prompted to provide local credentials.
brew install enclave
-
Once installed, enrol your system with your Enclave Organisation
sudo enclave enrol
Provide the Quick Start Key
from your account to complete the installation
Select your distribution:
Requires at least Ubuntu 14.04 LTS or Debian 9 or Raspbian 10.
-
Install apt-transport-https
sudo apt install apt-transport-https
-
Add Enclave’s package signing key and repository to apt sources
curl -fsSL https://packages.enclave.io/apt/enclave.stable.gpg | sudo gpg --dearmor -o /usr/share/keyrings/enclave.gpg echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/enclave.gpg] https://packages.enclave.io/apt stable main" | \ sudo tee /etc/apt/sources.list.d/enclave.stable.list sudo apt update
-
Install Enclave
sudo apt install enclave
-
Enrol
sudo enclave enrol
-
Provide your
Quick Start Key
to complete the installation
Select your version:
Requires CentOS or RHEL 7.
-
Install Enclave using our quick-start script
bash <(curl -Ss https://install.enclave.io/setup.sh)
-
Provide your
Quick Start Key
to complete the installation
Requires at least CentOS or RHEL 8.
-
Add Enclave’s repository to rpm sources
sudo dnf -y install dnf-plugins-core sudo dnf config-manager --add-repo https://packages.enclave.io/rpm/enclave.repo
-
Install Enclave
sudo dnf install enclave
-
Enrol
sudo enclave enrol
-
Provide your
Quick Start Key
to complete the installation
Requires at least Fedora 32.
-
Add Enclave’s repository to rpm sources
sudo dnf -y install dnf-plugins-core sudo dnf config-manager --add-repo https://packages.enclave.io/rpm/enclave.repo
-
Install Enclave
sudo dnf install enclave
-
Enrol
sudo enclave enrol
-
Provide your
Quick Start Key
to complete the installation
Requires at least Amazon Linux 2018.03.
-
Install Enclave using our quick-start script
bash <(curl -Ss https://install.enclave.io/setup.sh)
-
Provide your
Quick Start Key
to complete the installation
-
Add Enclave’s repository to rpm sources
sudo zypper addrepo https://packages.enclave.io/rpm/enclave.repo
-
Install Enclave
sudo zypper install enclave
-
Enrol
sudo enclave enrol
-
Provide your
Quick Start Key
to complete the installation
Requires at least Arch Linux 2020.08.01.
-
Install Enclave using our quick-start script
bash <(curl -Ss https://install.enclave.io/setup.sh)
-
Provide your
Quick Start Key
to complete the installation
Select your platform:
-
Create a
docker-compose.yml
file:version: '3.1' services: enclave-fabric: container_name: fabric image: enclavenetworks/enclave:latest restart: always cap_add: - NET_ADMIN devices: - /dev/net/tun environment: ENCLAVE_ENROLMENT_KEY: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX volumes: - enclave-config:/etc/enclave/profiles - enclave-logs:/var/log/enclave volumes: enclave-config: enclave-logs:
-
Replace
XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
with yourQuick Start Key
-
Bring the container up using
docker-compose up -d
-
Verify Enclave is running insider the container with
docker exec fabric enclave status
-
Add the enclave-sidecar to your pod yaml file under the
containers:
section. For example, if your pod contains an nginx container:spec: containers: - name: nginx-container image: nginx:1.7.9 ports: - containerPort: 80
Add the enclave-sidecar definition to below your existing pod:
spec: containers: - name: nginx-container ... - name: enclave-sidecar image: enclavenetworks/enclave:latest env: - name: "ENCLAVE_ENROLMENT_KEY" value: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" securityContext: capabilities: add: ['NET_ADMIN'] volumeMounts: - name: tun mountPath: /dev/net/tun volumes: - name: tun hostPath: type: 'CharDevice' path: /dev/net/tun
Tip
See pod.yaml for a complete example.
-
Replace
XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
with yourQuick Start Key
-
Push your changes to the cluster using
kubectl apply
or your preferred method
-
Install the Enclave Agent app from the Google Play Store.
-
Provide the
Quick Start Key
from your account to enrol the installed app.
Tip
You can help users enrol by providing them with an "enrolment key link", in the form: https://install.enclave.io/android?k=<enrolment key here>
If users click the link on their device, it will automatically open the Enclave Agent app and pre-populate the key without them needing to paste it in.
-
Install the Enclave Agent app from the App Store.
-
Provide the
Quick Start Key
from your account to enrol the installed app.
Coming Soon
We will soon support app links to improve the enrolment process for users; for now users will need to paste the enrolment key in the Enrolment screen.
Select your device:
- We have beta support for Synology NAS drives (running on DSM 7.0 or later) via docker. Please follow our guide to installing Enclave on your Synology NAS drive.
Congratulations! You've successfully enrolled a new system to your Enclave account. Once you've enrolled at least two systems, continue by attaching tags to your newly enrolled systems.