hacker-challenge/README.md
jakubDoka 09a84a15f3 rewrite (#2)
running clippy fix
separating homepage to a file
adding summary of network security
removing the rewrite structure
removing catch unwind
adding sealing to persistence
redirectng to the upstream
fixing some startup endgecases

Co-authored-by: Jakub Doka <jakub.doka2@gmail.com>
Reviewed-on: SGX/hacker-challenge-sgx#2
2024-11-08 14:33:42 +00:00

36 lines
1.1 KiB
Markdown

# Welcome to the HACKER CHALLENGE
## Building and packaging the challenge
The host can be without SGX support.
To build and package the challenge you will need the docker environment.
Do the following steps to build the challenge:
```bash
# Notice that there is no SGX device mounted, run inside rewrite directory
docker run --rm --name packager -it -v .:/root/rewrite occlum/occlum:latest-ubuntu20.04
# Inside the docker container run package.sh and follow its instructions
cd /root/rewrite && ./scripts/package.sh --prep
exit # Feel free to exit the container
```
## Testing the challenge
To test the challenge you will need the SGX support.
```bash
# this will boot few containers containing servers that will replicate the private key generated by one of the nodes
./scripts/testnet.sh
# to interact with the servers list the ports
docker container list
# pick some node and
curl localhost:your-port
# node will respond with a homepage with more information
```
The node homepage source is also [here](./src/HOMEPAGE.md).
## Contributing to the challenge
Don't forget to run `cargo clippy` and `cargo fmt` before submitting a PR.