Skip to content

Commit 949bf17

Browse files
committed
Update README.md
1 parent f908036 commit 949bf17

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ As of the time of writing, it supports two execution backends:
2121

2222
* A Linux User Namespaces executor, which is very fast and lightweight
2323

24-
* A Docker executor which is slower, but more compatible (it works on macOS, and may work on Windows)
24+
* A [Docker](https://www.docker.com/) (or [Podman](https://podman.io/)) executor which is slower, but more compatible (it works on macOS, and may work on Windows)
2525

2626
The executors are responsible for running/virtualizing a given `Cmd` within a root filesystem that is defined by the user, along with various paths that can be mounted within the sandbox.
2727
These capabilities were originally built for [BinaryBuilder.jl](https://github.com/JuliaPackaging/BinaryBuilder.jl), however this functionality is now mature enough that it may be useful elsewhere.
2828

2929
## Basic usage
3030

3131
To make use of this toolkit, you will need to have a root filesystem image that you want to use.
32-
This package comes with a minimal Debian rootfs that can be used for quick tests, to launch `/bin/bash` in an interactive shell, run the following:
32+
This package can download a minimal Debian rootfs that can be used for quick tests; to launch `/bin/bash` in an interactive shell run the following:
3333

3434
```julia
3535
using Sandbox
@@ -50,3 +50,10 @@ While this launches an interactive session due to hooking up `stdout`/`stdin`, o
5050
To use more interesting rootfs images, you can either create your own using tools such as [`debootstrap`](https://wiki.debian.org/Debootstrap) or you can pull one from docker by using the `pull_docker_image()` function defined within this package. See the [`contrib`](contrib/) directory for examples of both.
5151

5252
You can also check out the latest releases of the [`JuliaCI/rootfs-images` repository](https://github.com/JuliaCI/rootfs-images/), which curates a collection of rootfs images for use in CI workloads.
53+
54+
## Multiarch usage
55+
56+
Sandbox contains facilities for automatically registering `qemu-user-static` interpreters with `binfmt_misc` to support running on multiple architectures.
57+
As of the time of this writing, this is only supported on when running on a Linux host with the `x86_64`, `aarch64` or `powerpc64le` host architectures.
58+
The target architectures supported are `x86_64`, `i686`, `aarch64`, `armv7l` and `powerpc64le`.
59+
Note that while `qemu-user-static` is a marvel of modern engineering, it does still impose some performance penalties, and there may be occasional bugs that break emulation faithfulness.

0 commit comments

Comments
 (0)