Skip to content

Commit b74f562

Browse files
committed
samples: update README
Add a note about running as non-root, how to get help and make some minor visual changes
1 parent 360208c commit b74f562

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

samples/command_executer/README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,19 @@ and build an EIF.
2727
$ export NITRO_CLI_BLOBS=$(realpath ../../blobs/)
2828
$ nitro-cli build-enclave --docker-dir "./resources" --docker-uri mytag --output-file command-executer.eif
2929
```
30+
---
31+
**NOTES**
3032

31-
_NOTE: these steps can either be done on your local machine or on the EC2
32-
instance your going to launch the enclave._
33+
* In order to build an EIF as a non-root user, that user must be able to manage
34+
the docker daemon. Please see
35+
[the official Docker documentation](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
36+
to learn how to do that.
37+
* These steps can either be done on your local machine or on the EC2 instance
38+
where you are going to launch the enclave.
3339

34-
3. Copy __both__ the EIF __and__ the command-executer binary to the EC2
40+
---
41+
42+
3. Copy __both__ the EIF __and__ the `command-executer` binary to the EC2
3543
instance you are about to run an enclave on.
3644

3745
4. Launch an enclave with the EIF containing command-executer.
@@ -67,3 +75,9 @@ instance you are about to run an enclave on.
6775
```
6876
$ ./command-executer send-file --cid 16 --localpath "./stress-ng" --port 5005 --remotepath "/usr/bin/stress-ng"
6977
```
78+
79+
## Help
80+
Further information about the semantics of each command can be obtained by running
81+
```
82+
$ ./command-executer help [<command>]
83+
```

0 commit comments

Comments
 (0)