Skip to content

Commit

Permalink
Merge pull request ktock#202 from ktock/fix-docs
Browse files Browse the repository at this point in the history
fix docs
  • Loading branch information
ktock authored Jan 12, 2024
2 parents 5445782 + 2e6097c commit dd7caea
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[:arrow_down: **Download**]](https://github.com/ktock/container2wasm/releases)
[[:book: **Command reference**]](#command-reference)
[[:books: **Additional Documents**]](#additional-resources)
[[:arrow_forward: **Demo**]](https://ktock.github.io/container2wasm-demo/)
[[⬇️**Download**]](https://github.com/ktock/container2wasm/releases)
[[📖 **Command reference**]](#command-reference)
[[📚 **Additional Documents**]](#additional-resources)
[[▶️**Demo**]](https://ktock.github.io/container2wasm-demo/)

# container2wasm: Container to WASM converter

Expand Down Expand Up @@ -200,6 +200,7 @@ Options
- `--debug-image`: Enable debug print in the output image
- `--show-dockerfile`: Show default Dockerfile
- `--legacy`: Use "docker build" instead of buildx (no support for assets flag) (default:false)
- `--external-bundle`: Do not embed container image to the Wasm image but mount it during runtime
- `--help, -h`: show help
- `--version, -v: `print the version

Expand Down Expand Up @@ -310,7 +311,7 @@ Re-compilation (and possibe re-implementation) of the application is needed.

- [`./examples/`](./examples): Examples (python, php, on-browser, networking, etc.)
- `vscode-container-wasm`: VSCode extension for running containers on VSCode on browser (e.g. `github.dev`), leveraging container2wasm: https://github.com/ktock/vscode-container-wasm
- [`./extras/imagemounter`]: A helper tool for enabling to distributing and running container images on browser without pre-conversion of the images.
- [`./extras/imagemounter`](./extras/imagemounter/): A helper tool for enabling to distributing and running container images on browser without pre-conversion of the images.

## Acknowledgement

Expand Down
2 changes: 2 additions & 0 deletions examples/no-conversion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ The following outputs a Wasm image `out.wasm` that contains runc + Linux + CPU e
$ c2w --external-bundle out.wasm
```

> container2wasm >= 0.6.0 is needed.
Then, put a container image to the server in the standard [OCI Image Layout](https://github.com/opencontainers/image-spec/blob/v1.0.2/image-layout.md).
The following puts `ubuntu:22.04` container image to `/tmp/imageout/`.

Expand Down
6 changes: 4 additions & 2 deletions extras/imagemounter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,13 @@ As of now, the following image server is supported:
First, build basic dependencies:

```console
$ make imagemounter.wasm c2w
$ mkdir /tmp/outx/
$ ./out/c2w --external-bundle /tmp/outx/out.wasm
$ c2w --external-bundle /tmp/outx/out.wasm
$ make imagemounter.wasm
```

> container2wasm >= 0.6.0 is needed.
### Example on browser + HTTP Server

The following pulls `ubuntu:22.04` stored at https://ktock.github.io/ubuntu-oci-images/ubuntu-22.04-org-amd64 as [OCI Image Layout](https://github.com/opencontainers/image-spec/blob/v1.0.2/image-layout.md) and runs it on Wasm.
Expand Down

0 comments on commit dd7caea

Please sign in to comment.