Skip to content

Commit

Permalink
docs: remove emojis from headings
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasten committed Nov 17, 2023
1 parent 9294d42 commit 7937b14
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 8 deletions.
3 changes: 2 additions & 1 deletion docs/docs/getting-started/examples.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Examples 🧪
# Examples

Just installed EGo? Here are some examples to start your confidential development process.

Expand All @@ -19,6 +19,7 @@ Similar to the above, but the server manages remote attestation by itself. This
Vault is a common way to store secrets and share them on dynamic infrastructures. With EGo, you can build a confidential version of unmodified Vault.

## [WebAssembly with Wasmer](https://github.com/edgelesssys/ego/tree/master/samples/wasmer)

You can run WebAssembly inside EGo using Wasmer.

## [Microsoft Azure Attestation (MAA)](https://github.com/edgelesssys/ego/tree/master/samples/azure_attestation)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/install.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installing EGo 📦
# Installing EGo

## Install the snap

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
slug: /
---

# Welcome to EGo 🎉
# Welcome to EGo

EGo is a framework for building *confidential apps* in Go. Confidential apps run in secure execution environments called *enclaves*. Enclaves are strongly isolated, runtime encrypted, and attestable. Enclaves can be created on Intel processors that have the SGX (Software Guard Extensions) feature.

In essence, EGo lets you run any Go program inside an enclave - without requiring modifications. Apps that benefit from enclaves are typically server applications that deal with sensitive data like cryptographic keys or payment data. HashiCorp Vault is a great example of such an app.

## Philosophy 🎓
## Philosophy

EGo's goal is to bridge the gap between cloud-native and confidential computing. EGo's philosophy is to get as many enclave specifics out of your way as possible. Fundamentally, building and running an enclave with EGo is as simple as building and running an app with normal Go:

Expand All @@ -18,7 +18,7 @@ ego sign myapp
ego run myapp
```

## Architecture 🏗
## Architecture

In a nutshell, EGo comprises a modified Go compiler, additional tooling, and a Go library.

Expand Down
5 changes: 3 additions & 2 deletions docs/docs/workflows/build.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Build your app with EGo 👷‍♀️
# Build your app with EGo

## `ego-go` replaces `go`

Expand All @@ -10,7 +10,7 @@ ego-go build

## Sign and run

After you've built your app, sign it with the [`ego sign`](../reference/cli.md#sign) command. Just insert the name of your binary in the following command:
After you've built your app, sign it with the [`ego sign`](../reference/cli.md#ego-sign) command. Just insert the name of your binary in the following command:

```bash
ego sign <executable>
Expand All @@ -21,6 +21,7 @@ Run the executable with
```bash
ego run <executable>
```

You can set the `OE_SIMULATION=1` environment variable if you want to simulate the enclave, e.g. for development on hardware that doesn't support enclaves.

Look at the [example collection](../getting-started/examples.md) if you want to see the build process in action.
10 changes: 9 additions & 1 deletion docs/docs/workflows/debug.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Debug your app 🔬
# Debug your app

EGo executables can be debugged inside as well as outside of enclaves. Depending on the task, you may prefer one or the other.

## Outside an enclave

An EGo executable can be run as a normal host process without an enclave. Thus, it can also be debugged like any other Go program. This should be your first attempt if the problem isn't related to specific enclave functionality. Use your favorite tools (e.g. the Delve debugger) as usual.

## Inside an enclave

EGo comes with `ego-gdb` that augments `gdb` with enclave support. The `console` interface is the same as `gdb`:

```bash
ego-gdb --args ./helloworld
```
Expand All @@ -17,7 +21,9 @@ Setting up the `mi` interface for VSCode is a bit trickier. First, install the [
Use one of the following templates for your `.vscode/launch.json` file. Just replace `samples/helloworld/helloworld` with the path to your EGo executable.

### Snap

If you installed the EGo snap, use this:

```json
{
"version": "0.2.0",
Expand Down Expand Up @@ -57,7 +63,9 @@ If you installed the EGo snap, use this:
```

### DEB package or built from source

If you installed the DEB package or built it yourself, use this:

```json
{
"version": "0.2.0",
Expand Down

0 comments on commit 7937b14

Please sign in to comment.