mirror of
https://github.com/ben-grande/qusal.git
synced 2024-12-26 07:59:37 -05:00
52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
# mirage-builder
|
|
|
|
Mirage Builder environment in Qubes OS.
|
|
|
|
## Table of Contents
|
|
|
|
* [Description](#description)
|
|
* [Installation](#installation)
|
|
* [Usage](#usage)
|
|
|
|
## Description
|
|
|
|
Setup a builder qube for Mirage Unikernel named "mirage-builder". The tool
|
|
necessary to build Mirage with docker or directly with Opam will also be
|
|
installed.
|
|
|
|
## Installation
|
|
|
|
Mirage Firewall commits and tags are not signed by individuals, but as they
|
|
are done through the web interface, they have GitHub Web-Flow signature. This
|
|
is the best verification we can get for Mirage Firewall. If you don't trust
|
|
the hosting provider however, don't install this package.
|
|
|
|
- Top
|
|
```sh
|
|
qubesctl top.enable mirage-builder
|
|
qubesctl --targets=tpl-mirage-builder,mirage-builder state.apply
|
|
qubesctl top.disable mirage-builder
|
|
```
|
|
|
|
- State
|
|
<!-- pkg:begin:post-install -->
|
|
```sh
|
|
qubesctl state.apply mirage-builder.create
|
|
qubesctl --skip-dom0 --targets=tpl-mirage-builder state.apply mirage-builder.install
|
|
qubesctl --skip-dom0 --targets=mirage-builder state.apply mirage-builder.configure
|
|
```
|
|
<!-- pkg:end:post-install -->
|
|
|
|
## Usage
|
|
|
|
The qube `mirage-builder` is intended to build Mirage Unikernel. Consult
|
|
upstream documentation on [how to build qubes-mirage-firewall from
|
|
source](https://github.com/mirage/qubes-mirage-firewall#build-from-source).
|
|
|
|
If you plan to build without docker, the hooks and completion scripts are
|
|
already being sourced by your shell profile. Because of this, when calling
|
|
`opam-init`, use it together with the option `--no-setup`:
|
|
```sh
|
|
opam init --no-setup
|
|
```
|