(feat) Docker: Add Support for Running inside Docker Container (#501)

* (feat) Docker: Add Support for Running inside Docker Container

Uses Alpine image as base to have minimal size. 2-step build process to get rid of source and library files after compilation and during runtime. Uses Python3 HTTP Server to serve static assets.

Signed-off-by: Progyan Bhattacharya <bprogyan@gmail.com>
This commit is contained in:
Progyan Bhattacharya 2021-07-24 18:37:14 +05:30 committed by GitHub
parent 4f6acde821
commit 9679e2c00a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 57 additions and 26 deletions

View file

@ -5,7 +5,7 @@ WebAssembly modules at runtime in order to achieve decent performance. Here's a
list of emulated hardware:
- An x86-compatible CPU. The instruction set is around Pentium III level,
including full SSE2 support. Some features are missing, in particular:
including full SSE2 support. Some features are missing, in particular:
- Task gates, far calls in protected mode
- Some 16 bit protected mode features
- Single stepping (trap flag, debug registers)
@ -30,8 +30,7 @@ list of emulated hardware:
- A virtio filesystem.
- A SoundBlaster 16 sound card.
Demos
-
## Demos
[Arch Linux](https://copy.sh/v86/?profile=archlinux) —
[Damn Small Linux](https://copy.sh/v86/?profile=dsl) —
@ -51,9 +50,7 @@ Demos
[KolibriOS](https://copy.sh/v86/?profile=kolibrios) —
[QNX](https://copy.sh/v86/?profile=qnx)
Compatibility
-
## Compatibility
Here's an overview of the operating systems supported in v86:
@ -87,8 +84,7 @@ Here's an overview of the operating systems supported in v86:
You can get some infos on the disk images here: https://github.com/copy/images.
How to build, run and embed?
-
## How to build, run and embed?
You need:
@ -102,7 +98,6 @@ You need:
See `tools/docker/test-image/Dockerfile` for a full setup on Debian.
- Run `make` to build the debug build (at `debug.html`).
- Run `make all` to build the optimized build (at `index.html`).
- ROM and disk images are loaded via XHR, so if you want to try out `index.html`
@ -111,9 +106,15 @@ See `tools/docker/test-image/Dockerfile` for a full setup on Debian.
- If you only want to embed v86 in a webpage you can use libv86.js. For
usage, check out the [examples](examples/).
### Alternatively, to build using docker
Testing
-
- If you have docker installed, you can run the whole system inside a container.
- See `tools/docker/exec` to find Dockerfile required for this.
- You can run `docker build -f tools/docker/exec/Dockerfile -t v86:alpine-3.14 .` from the root directory to generate docker image.
- Then you can simply run `docker run -it v86:alpine-3.14 -p 8000:800` to start the server.
- Check `localhost:8000` for hosted server.
## Testing
The disk images for testing are not included in this repository. You can
download them directly from the website using:
@ -124,9 +125,7 @@ Run all tests: `make jshint rustfmt kvm-unit-test nasmtests nasmtests-force-jit
See [tests/Readme.md](tests/Readme.md) for more infos.
API examples
-
## API examples
- [Basic](examples/basic.html)
- [Programatically using the serial terminal](examples/serial.html)
@ -154,9 +153,7 @@ var emulator = new V86Starter({
See [starter.js](src/browser/starter.js).
License
-
## License
v86 is distributed under the terms of the Simplified BSD License, see
[LICENSE](LICENSE). The following third-party dependencies are included in the
@ -167,9 +164,7 @@ repository under their own licenses:
- [`tests/kvm-unit-tests/`](tests/kvm-unit-tests)
- [`tests/qemutests/`](tests/qemutests)
Credits
-
## Credits
- CPU test cases via [QEMU](https://wiki.qemu.org/Main_Page)
- More tests via [kvm-unit-tests](https://www.linux-kvm.org/page/KVM-unit-tests)
@ -178,14 +173,10 @@ Credits
- [The jor1k project](https://github.com/s-macke/jor1k) for 9p, filesystem and uart drivers
- [WinWorld](https://winworldpc.com/) sources of some old operating systems
More questions?
-
## More questions?
Shoot me an email to `copy@copy.sh`. Please report bugs on GitHub.
Author
-
## Author
Fabian Hemmer (https://copy.sh/, `copy@copy.sh`)

15
tools/docker/README.md Normal file
View file

@ -0,0 +1,15 @@
# Dockerfiles
This directory contains Dockerfile to generate images for various purposes.
## debian
To create a Docker image to run Debian inside v86.
## exec
To create a Docker image to build and host v86 system and expose in a port (default 8000).
## test-image
To create a Docker image that runs v86 tests.

View file

@ -0,0 +1,20 @@
FROM alpine:3.14 as v86-builder
WORKDIR /v86
RUN apk add --update curl clang make openjdk8 npm python3
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y && PATH="${HOME}/.cargo/bin:${PATH}" rustup target add wasm32-unknown-unknown
COPY . .
RUN PATH="${HOME}/.cargo/bin:${PATH}" make all && rm -rf closure-compiler gen lib src tools .cargo cargo.toml Makefile
FROM python:3.9.6-alpine3.14
WORKDIR /v86
COPY --from=v86-builder v86 .
ARG PORT=8000
CMD python3 -m http.server ${PORT}
EXPOSE ${PORT}

5
tools/docker/exec/build.sh Executable file
View file

@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -euo pipefail
cd "$(dirname "$0")"
tar -cf - ../../../{*.html,*.js,*.css,gen,lib,src,bios,.cargo,Cargo.toml,Makefile,tools} | \
docker build -t v86:alpine-3.14 -f tools/docker/exec/Dockerfile -