Skip to content

Commit 1038eb3

Browse files
committed
refactor: update iApp guides and sidebar links
- Renamed sidebar links for clarity, changing 'Build your first application' to 'Build your first iApp' and 'Build Intel TDX app' to 'Build Intel TDX iApp'. - Updated references in documentation to reflect the new iApp terminology and paths. - Added new guides for building Intel TDX and SGX iApps, while removing outdated references to 'Create Your First SGX App'.
1 parent 58df66d commit 1038eb3

File tree

15 files changed

+159
-137
lines changed

15 files changed

+159
-137
lines changed

.vitepress/sidebar.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,11 @@ export function getSidebar() {
208208
},
209209
{
210210
text: 'Build your first application',
211-
link: '/guides/build-iapp/advanced/build-your-first-app',
211+
link: '/guides/build-iapp/advanced/build-your-first-iapp',
212212
},
213213
{
214214
text: 'Build your first SGX app',
215-
link: '/guides/build-iapp/advanced/create-your-first-sgx-app',
215+
link: '/guides/build-iapp/advanced/build-your-first-sgx-iapp',
216216
},
217217
{
218218
text: 'End-to-end Encryption',
@@ -224,7 +224,7 @@ export function getSidebar() {
224224
},
225225
{
226226
text: 'Build Intel TDX app',
227-
link: '/guides/build-iapp/advanced/build-your-first-tdx-app',
227+
link: '/guides/build-iapp/advanced/build-your-first-tdx-iapp',
228228
},
229229
],
230230
},

src/get-started/protocol/tee/intel-sgx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,5 +144,5 @@ graph TD
144144

145145
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first SGX
146146
application
147-
- **[Advanced SGX Development](/guides/build-iapp/advanced/create-your-first-sgx-app)** -
147+
- **[Advanced SGX Development](/guides/build-iapp/advanced/build-your-first-sgx-iapp)** -
148148
Deep dive into SGX development

src/get-started/protocol/tee/intel-tdx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ graph TD
137137

138138
**Ready to experiment with TDX?** Check out the practical guides:
139139

140-
- **[Build Intel TDX App (Experimental)](/guides/build-iapp/advanced/build-your-first-tdx-app)** -
140+
- **[Build Intel TDX iApp (Experimental)](/guides/build-iapp/advanced/build-your-first-tdx-iapp)** -
141141
Build TDX applications with traditional deployment and iApp Generator
142-
- **[Build Your First TDX App](/guides/build-iapp/advanced/build-your-first-tdx-app)** -
142+
- **[Build Your First TDX iApp](/guides/build-iapp/advanced/build-your-first-tdx-iapp)** -
143143
Build TDX applications
144144

145145
**For production applications, use SGX**:

src/get-started/protocol/tee/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ TEE technologies have evolved to address different use cases:
119119

120120
**Ready to build with TEE?** Check out the practical guides:
121121

122-
- **[Build Intel TDX App (Experimental)](/guides/build-iapp/advanced/build-your-first-tdx-app)** -
122+
- **[Build Intel TDX iApp (Experimental)](/guides/build-iapp/advanced/build-your-first-tdx-iapp)** -
123123
Build TDX applications with traditional deployment and iApp Generator
124124
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first TEE
125125
application

src/get-started/protocol/tee/sgx-vs-tdx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ technology** for advanced use cases.
7979

8080
**Ready to build with TEE?** Check out the practical guides:
8181

82-
- **[Build Intel TDX App (Experimental)](/guides/build-iapp/advanced/build-your-first-tdx-app)** -
82+
- **[Build Intel TDX iApp (Experimental)](/guides/build-iapp/advanced/build-your-first-tdx-iapp)** -
8383
Build TDX applications with traditional deployment and iApp Generator
8484
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first TEE
8585
application

src/guides/build-iapp/advanced/access-confidential-assets.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: Access Confidential Assets from Your App
2+
title: Access Confidential Assets from Your iApp
33
description:
44
Learn how to access confidential assets including secrets, protected data, and
55
requester secrets from your iExec application using the Secret Management
66
Service
77
---
88

9-
# Access confidential assets from your app
9+
# Access confidential assets from your iApp
1010

1111
::: warning
1212

1313
Before going any further, make sure you managed to
14-
[Build your first application with Scone framework](create-your-first-sgx-app.md).
14+
[Build your first application with Scone framework](build-your-first-sgx-iapp.md).
1515

1616
:::
1717

@@ -53,8 +53,8 @@ graph TD
5353
ProtectedDataOwn[ProtectedData owner] -->|1.c. Push secret| SMS
5454
Req --> |2 . Buy task| Chain
5555
Chain[Blockchain] --> |3 . Notify task to compute| Worker[Worker/Workerpool]
56-
Worker --> |4 . Launch TEE application| App[TEE application]
57-
App --> |5.a. Get secrets for task| SMS
56+
Worker --> |4 . Launch TEE application| iApp[TEE application]
57+
iApp --> |5.a. Get secrets for task| SMS
5858
SMS --> |5.b. Check authorization for secrets| Chain
5959
```
6060

src/guides/build-iapp/advanced/build-your-first-app.md renamed to src/guides/build-iapp/advanced/build-your-first-iapp.md

Lines changed: 44 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
---
2-
title: Build Your First Application
2+
title: Build Your First iApp
33
description:
4-
In this section we will show you how you can create a Docker dapp over the
5-
iExec infrastructure.
4+
In this section we will show you how you can create an iApp over the iExec
5+
infrastructure.
66
---
77

8-
# Build your first application
8+
# Build your first iApp
99

10-
> In this section we will show you how you can create a Docker dapp over the
11-
> iExec infrastructure.
10+
> In this section we will show you how you can create an iApp (iExec
11+
> confidential application) over the iExec infrastructure.
1212
1313
::: tip Prerequisites
1414

1515
- [Docker](https://docs.docker.com/install/) 17.05 or higher on the daemon and
1616
client.
1717
- [Dockerhub](https://hub.docker.com/) account.
1818
- [iExec SDK](https://www.npmjs.com/package/iexec) 8.0.0 or higher.
19-
[Install the iExec SDK](quick-start-for-developers.md#install-the-iexec-sdk).
20-
- [Quickstart](quick-start-for-developers.md) tutorial completed
19+
- [Quickstart](./quick-start.md) tutorial completed
2120

2221
:::
2322

24-
In this guide, we will prepare an iExec app based on an existing docker image
23+
In this guide, we will prepare an iExec iApp based on an existing docker image
2524
and we will run it on iExec decentralized infrastructure.
2625

27-
## Understand what is an iExec decentralized application?
26+
## Understand what is an iExec decentralized application (iApp)?
2827

2928
iExec leverage [Docker](https://www.docker.com/why-docker) containers to ensure
3029
the execution of your application on a decentralized infrastructure. iExec
@@ -46,19 +45,19 @@ supports Linux-based docker images.
4645
Today you can run any application as a task. This means services are not
4746
supported for now.
4847

49-
## Build your app
48+
## Build your iApp
5049

5150
Create the folder tree for your application in `~/iexec-projects/`.
5251

5352
```bash
5453
cd ~/iexec-projects
55-
mkdir hello-world-app
56-
cd hello-world-app
54+
mkdir hello-world-iapp
55+
cd hello-world-iapp
5756
mkdir src
5857
touch Dockerfile
5958
```
6059

61-
### Write the app
60+
### Write the iApp
6261

6362
::: warning
6463

@@ -137,7 +136,7 @@ application. Execution logs are accessible by:
137136

138137
:::
139138

140-
### Dockerize your app
139+
### Dockerize your iApp
141140

142141
**Copy the following content** in `Dockerfile` .
143142

@@ -192,7 +191,7 @@ way to name the image to reuse it in the next steps.
192191

193192
**Congratulations you built your first docker image for iExec!**
194193

195-
## Test your app locally
194+
## Test your iApp locally
196195

197196
### Basic test
198197

@@ -261,9 +260,9 @@ docker run \
261260
arg1 arg2 arg3
262261
```
263262

264-
## Test your app on iExec
263+
## Test your iApp on iExec
265264

266-
### Push your app to Dockerhub
265+
### Push your iApp to Dockerhub
267266

268267
Login to your Dockerhub account.
269268

@@ -289,30 +288,30 @@ Push the image to Dockerhub.
289288
docker push <docker-hub-user>/hello-world:1.0.0
290289
```
291290

292-
**Congratulations, your app is ready to be deployed on iExec!**
291+
**Congratulations, your iApp is ready to be deployed on iExec!**
293292

294-
### Deploy your app on iExec
293+
### Deploy your iApp on iExec
295294

296-
You already learned how to deploy the default app on iExec in the
297-
[previous tutorial](quick-start-for-developers.md).
295+
You already learned how to deploy the default iApp on iExec in the
296+
[previous tutorial](./quick-start.md).
298297

299298
Go back to the `iexec-project` folder.
300299

301300
```bash
302301
cd ~/iexec-projects/
303302
```
304303

305-
You will need a few configurations in `iexec.json` to deploy your app:
304+
You will need a few configurations in `iexec.json` to deploy your iApp:
306305

307-
- Replace app **name** with your application name \(display only\)
308-
- Replace app **multiaddr** with your app image download URI \(should looks like
309-
`docker.io/<docker-hub-user>/hello-world:1.0.0`\)
310-
- Replace app **checksum** with your application image checksum \(see tip
306+
- Replace iApp **name** with your application name \(display only\)
307+
- Replace iApp **multiaddr** with your iApp image download URI \(should looks
308+
like `docker.io/<docker-hub-user>/hello-world:1.0.0`\)
309+
- Replace iApp **checksum** with your application image checksum \(see tip
311310
below\)
312311

313312
::: info
314313

315-
The checksum of your app is the sha256 digest of the docker image prefixed with
314+
The checksum of your iApp is the sha256 digest of the docker image prefixed with
316315
`0x` , you can use the following command to get it.
317316

318317
```bash
@@ -321,19 +320,19 @@ docker pull <docker-hub-user>/hello-world:1.0.0 | grep "Digest: sha256:" | sed '
321320

322321
:::
323322

324-
Deploy your app on iExec
323+
Deploy your iApp on iExec
325324

326325
```bash twoslash
327326
iexec app deploy --chain {{chainName}}
328327
```
329328

330-
Verify the deployed app \(name, multiaddr, checksum, owner\)
329+
Verify the deployed iApp \(name, multiaddr, checksum, owner\)
331330

332331
```bash twoslash
333332
iexec app show --chain {{chainName}}
334333
```
335334

336-
### Run your app on iExec
335+
### Run your iApp on iExec
337336

338337
```bash twoslash
339338
iexec app run --chain {{chainName}} --workerpool {{workerpoolAddress}} --watch
@@ -343,19 +342,19 @@ iexec app run --chain {{chainName}} --workerpool {{workerpoolAddress}} --watch
343342

344343
**Using arguments:**
345344

346-
You can pass arguments to the app using `--args <args>` option.
345+
You can pass arguments to the iApp using `--args <args>` option.
347346

348-
With `--args "dostuff --with-option"` the app will receive
347+
With `--args "dostuff --with-option"` the iApp will receive
349348
`["dostuff", "--with-option"]` as process args.
350349

351350
**Using input files:**
352351

353-
You can pass input files to the app using `--input-files <list of URL>` option.
352+
You can pass input files to the iApp using `--input-files <list of URL>` option.
354353

355354
With
356355
`--input-files https://example.com/file-A.txt,https://example.com/file-B.zip`
357-
the iExec worker will download the files before running the app in `IEXEC_IN`,
358-
and let the app access them through variables:
356+
the iExec worker will download the files before running the iApp in `IEXEC_IN`,
357+
and let the iApp access them through variables:
359358

360359
- `file-A.txt` as`IEXEC_INPUT_FILE_NAME_1`
361360
- `file-B.zip` as`IEXEC_INPUT_FILE_NAME_2`
@@ -370,9 +369,9 @@ iexec task show --chain {{chainName}} <taskid> --download my-app-result \
370369
&& unzip my-app-result.zip -d my-app-result
371370
```
372371

373-
**Congratulations your app successfully ran on iExec!**
372+
**Congratulations your iApp successfully ran on iExec!**
374373

375-
## Manage your app's output
374+
## Manage your iApp's output
376375

377376
iExec enables running apps producing output files, you will need a place for
378377
storing your apps outputs.
@@ -390,12 +389,12 @@ the[iExec SDK](https://github.com/iExecBlockchainComputing/iexec-sdk).
390389

391390
:::
392391

393-
## Access to app and task logs on iExec
392+
## Access to iApp and task logs on iExec
394393

395394
Sometimes things don't work out right the first time and you may need to
396395
[Debug your tasks](/guides/build-iapp/debugging).
397396

398-
## Publish your app on the iExec marketplace
397+
## Publish your iApp on the iExec marketplace
399398

400399
```bash twoslash
401400
iexec app publish --chain {{chainName}}
@@ -405,14 +404,14 @@ iexec app publish --chain {{chainName}}
405404

406405
## What's next?
407406

408-
In this tutorial you learned about the key concepts for building an app on
407+
In this tutorial you learned about the key concepts for building an iApp on
409408
iExec:
410409

411-
- iExec app inputs and outputs
412-
- iExec app must produce a `computed.json` file \(required for the proof of
410+
- iExec iApp inputs and outputs
411+
- iExec iApp must produce a `computed.json` file \(required for the proof of
413412
execution\)
414-
- using docker to package your app with all its dependencies
415-
- testing an iExec app locally
413+
- using docker to package your iApp with all its dependencies
414+
- testing an iExec iApp locally
416415
- publishing on dockerhub
417416

418417
<script setup>

0 commit comments

Comments
 (0)