Unverified Commit 0615dc53 authored by kladko's avatar kladko

Fix test

1 merge request!1Develop
......@@ -53,7 +53,7 @@ Never run a production sgxserver in simulation mode.
If you are a SKALE validator and want to run sgxwallet for testnet or mainnet usage, you need
a SGX-capable server.
Please refer to Admin guide for details on how to setup sgxwallet in a secure hardware mode.
Please refer to Admin guide for details on how to setup sgxwallet in a secure hardware mode
[docs/admin_guide.md](docs/admin_guide.md).
## Developer guide
......
......@@ -5,14 +5,8 @@
sgxwallet depends on several freely available
software components. These must be installed and configured before
running sgxwallet.
This docment describes how to install and configure these required components.
This document describes how to install and configure these required components.
# Table of Contents
- [Recommend Host System](#recommended-host-system)
- [Docker](#docker)
- [Intel® Software Guard Extensions (Intel SGX)](#sgx)
- [Troubleshooting Installation](#troubleshooting-installation)
## Recommended host system
......@@ -23,9 +17,9 @@ but the installation process is likely to be more complicated,
and the use of other distributions is not supported by their respective communities at this time.
### To install Docker CE Engine:
### Install Docker engine ngine:
Docker CE engine is pre-installed on Ubuntu 18.04. You can re-install it as
Docker engine is pre-installed on Ubuntu 18.04. You can re-install it as
described below
```bash
......@@ -34,7 +28,7 @@ sudo apt-get install -y docker-io
To verify a correct installation, run `sudo docker run hello-world`
### To install Docker Compose:
### Install Docker Compose:
```bash
sudo apt-get install -y docker-compose
......@@ -44,22 +38,10 @@ To verify a correct installation, run `docker-compose version`
For details on Docker installation, see <https://docs.docker.com/engine/installation/linux/ubuntu> and <https://docs.docker.com/compose/install/#install-compose>
## Intel® Software Guard Extensions (Intel SGX)
Sgxwallet is intended to be run on Intel SGX-enabled platforms.
However, it can also be run in "simulator mode" on platforms that do not have hardware support for Intel SGX.
Support for other hardware-based Trusted Execution Environments (TEEs) can be added by submitting a Pull Request.
### Intel SGX in Hardware Mode
If you plan to run this on Intel SGX-enabled hardware, you will need to
install the Intel SGX driver and install additional packages
for both standalone and docker builds.
You need to install the Intel SGX driver whether you build Avalon standalone
or using Docker.
### Check your machine supports SGX
Before installing Intel SGX software, install these packages:
Install these packages:
```bash
sudo apt-get install -y libelf-dev cpuid
......@@ -69,6 +51,9 @@ sudo apt-get install -y libelf-dev cpuid
Verify your processor supports Intel SGX with:
`cpuid | grep SGX:`
### Verify Intel SGX is enabled in BIOS
Verify Intel SGX is enabled in BIOS.
Enter BIOS by pressing the BIOS key during boot.
The BIOS key varies by manufacturer and could be F10, F2, F12, F1, DEL, or ESC.
......@@ -77,22 +62,6 @@ If disabled, enter BIOS and find the Intel SGX feature
(it is usually under the "Advanced" or "Security" menu),
enable Intel SGX, save your BIOS settings, and exit BIOS.
Download and install libsgx-enclave-common version 2.5.101:
```bash
wget https://download.01.org/intel-sgx/sgx_repo/ubuntu/pool/main/libs/libsgx-enclave-common/libsgx-enclave-common_2.5.101.50123-bionic1_amd64.deb
sudo dpkg -i libsgx-enclave-common_2.5.101.50123-bionic1_amd64.deb
```
### Intel SGX in Simulator-mode
If running only in simulator mode (no hardware support), you only
need the Intel SGX SDK.
`SGX_MODE` is optional. If set, it must be set to `SIM` (the default).
Verify `SGX_MODE` is not set, or is set to `SIM`, with `echo $SGX_MODE` .
## Troubleshooting Installation
- If the message `intel_sgx: SGX is not enabled` appears in `/var/log/syslog`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment