Skip to content

docs/rofl: Simplify rofl build instructions #2411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ptrus merged 1 commit into from
Dec 11, 2025
Merged

docs/rofl: Simplify rofl build instructions #2411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 3 additions & 12 deletions docs/rofl/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,18 +135,9 @@ If the transaction succeeds, you should be able to find your app on the

Next, build the ROFL bundle.

<Tabs>
<TabItem value="Native Linux">
```shell
oasis rofl build
```
</TabItem>
<TabItem value="Docker (Windows, Mac, Linux)">
```shell
docker run --platform linux/amd64 --volume .:/src -it ghcr.io/oasisprotocol/rofl-dev:main oasis rofl build
```
</TabItem>
</Tabs>
```shell
oasis rofl build
```

As a result, a new `.orc` file will appear inside your project folder.

Expand Down
18 changes: 3 additions & 15 deletions docs/rofl/workflow/build.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Build

This operation packs `compose.yaml`, specific operating system components and
Expand All @@ -20,18 +17,9 @@ before granting them access to the key management system and [other features].

To build an app and update the enclave identity in the app manifest, simply run:

<Tabs>
<TabItem value="Native Linux">
```shell
oasis rofl build
```
</TabItem>
<TabItem value="Docker (Windows, Mac, Linux)">
```shell
docker run --platform linux/amd64 --volume .:/src -it ghcr.io/oasisprotocol/rofl-dev:main oasis rofl build
```
</TabItem>
</Tabs>
```shell
oasis rofl build
```

This will generate a ROFL bundle which can be used for later deployment and
output something like:
Expand Down
14 changes: 2 additions & 12 deletions docs/rofl/workflow/prerequisites.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,12 @@ Pick among the three setups below.

1. [Download and install][oasis-cli-setup] the Oasis CLI to your platform.

2. For building apps for ROFL, the Oasis team prepared the
[`ghcr.io/oasisprotocol/rofl-dev`][rofl-dev] image. It contains all
the tools needed to compile any ROFL flavor of your app. You can test it out
by running:
2. Test that everything works by building the ROFL app:

```shell
docker run --platform linux/amd64 --rm -v .:/src -it ghcr.io/oasisprotocol/rofl-dev:main oasis rofl build
oasis rofl build
```

:::info --platform linux/amd64

Always provide the `--platform linux/amd64` parameter to the `rofl-dev` image,
no matter which processor your computer has or the operating system you're running.

:::

[rofl-dev]: https://github.com/oasisprotocol/oasis-sdk/pkgs/container/rofl-dev
[oasis-cli-setup]: ../../tools/cli/setup.mdx

Expand Down
Loading