Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mirage/mirage
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 7779a7b30830
Choose a base ref
...
head repository: mirage/mirage
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: fa0dd454907d
Choose a head ref
  • 3 commits
  • 1 file changed
  • 2 contributors

Commits on Mar 7, 2016

  1. Update Readme 

    Edited initial paragraph. Commented out the other material and
instead pointed at the main website.
    @amirmc
    amirmc committed Mar 7, 2016
    Copy the full SHA
    2210255 View commit details

  2. README tweaks

    @amirmc
    amirmc committed Mar 7, 2016

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    GPG key ID: 4AEE18F83AFDEB23
    Expired
    Verified
    Learn about vigilant mode
    Copy the full SHA
    ca98dfe View commit details

Commits on Mar 14, 2016

  1. Merge pull request #508 from amirmc/readme 

    Update Readme
    @samoht
    samoht committed Mar 14, 2016
    Copy the full SHA
    fa0dd45 View commit details
Showing with 35 additions and 15 deletions.
  1. +35 −15 README.md
50 changes: 35 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Mirage
## MirageOS

Mirage is a programming framework for constructing secure, high-performance
network applications across a variety of cloud computing and mobile platforms.
Code can be developed on a normal OS such as Linux or MacOS X, and then compiled
into a fully-standalone, specialised unikernel that runs under the Xen
hypervisor. Since Xen powers most public cloud computing infrastructure such as
Amazon EC2, this lets your servers run more cheaply, securely and finer control
than with a full software stack.
MirageOS is a library operating system that constructs unikernels for secure,
high-performance network applications across a variety of cloud computing and
mobile platforms. Code can be developed on a normal OS such as Linux or
MacOS X, and then compiled into a fully-standalone, specialised unikernel that
runs under the Xen hypervisor. Since Xen powers most public cloud computing
infrastructure such as Amazon EC2 or Rackspace, this lets your servers run
more cheaply, securely and with finer control than with a full software stack.

The most up-to-date documentation can be found at the
[homepage](https://mirage.io). The site is self-hosted and a useful
@@ -21,33 +21,52 @@ available online.

This repository includes:

* a command-line tool to create and deploy applications with Mirage; and
* a command-line tool to create and deploy applications with MirageOS; and
* in `types/`, a library of type signatures that compliant applications use.

There are several diverse backends in Mirage that require rather specialised
There are several diverse backends in MirageOS that require rather specialised
build steps (from JavaScript to Xen unikernels), and this complexity is wrapped
up in the tool.

To work with Mirage, you'll need the following prerequisites installed:
To work with `mirage`, you'll need to either install prerequisites
locally or use the Docker image.

* a working [OCaml](http://ocaml.org) compiler (4.01.0 or higher).
**Local install**

You will need the following:

* a working [OCaml](http://ocaml.org) compiler (4.02.3 or higher).
* the [OPAM](https://opam.ocaml.org) source package manager (1.2.0 or higher).
* an x86\_64 or armel Linux host to compile Xen kernels, or FreeBSD, OpenBSD or
MacOS X for the userlevel version.

**Docker image**

There is a maintained Docker image at
[unikernel/mirage](https://hub.docker.com/r/unikernel/mirage/).

### Using `mirage`

There are two stages to using `mirage`:

* a *configure* phase where OPAM package dependencies are satisfied.
* a *build* phase where the compiler and any support scripts are run.

You can find documentation, walkthroughs and tutorials over on the
[MirageOS website](https://mirage.io).
The [install instructions](https://mirage.io/wiki/install)
are a good place to begin!

<!-- AC: Commented out rather than deleting
### Configuration files
`mirage` currently uses a configuration file to build a Mirage unikernel. While
`mirage` currently uses a configuration file to build a MirageOS unikernel. While
we're documenting it all, please see the `lib_test` directory in this repository
for the regression examples. The latest instructions are also to be found at
<http://openmirage.org/docs>
<https://mirage.io/docs>
### Configuring Mirage Applications
### Configuring MirageOS Applications
Provided that one and only one file of name `<foo>.conf` (where `<foo>` can be
any string) is present in the current working directory, the command:
@@ -106,3 +125,4 @@ tools on your machine, build a unikernel with the `--xen` option and then use
the `ec2.sh` script (in directory `script`) in order to register your kernel
with AWS. Then you can start your kernel with the web interface to AWS or any
other means AWS provides to start EC2 instances.
-->