Installation

Before you start#

Check that the computer meets the requirements: 64-bit Ubuntu Desktop 26.04 LTS, virtualization enabled in the BIOS/UEFI, a GPU with Vulkan and its driver installed, at least 12 GB free and an internet connection.

You also need the version's two files, published in the #osx-reims channel of the members' Discord (see Getting OSX-REIMS):

• osx-reims_0.3.0_amd64.deb, the package;
• osx-reims_0.3.0_amd64.deb.sha256, its checksum.

1. Update the system#

Recommended before the first installation:

sudo apt update && sudo apt full-upgrade

2. Verify the download#

Put both files in the same folder, open a terminal there and run:

sha256sum -c osx-reims_0.3.0_amd64.deb.sha256

The output must end in OK. If it says FAILED, download the files again.

3. Install the package#

sudo apt install ./osx-reims_0.3.0_amd64.deb

The ./ tells apt that the package is a local file. At the end, the installation shows the next step.

4. Prepare the computer#

Run it as your normal user:

osx-reims setup

Before changing anything, setup asks:

1. License. It shows a summary of the OSX-REIMS license. Answer y to accept, n to decline or r to read the full text. OSX-REIMS cannot be used until the license is accepted.
2. Reims vGPU version (first run only). Choose 1 for the version tested with this OSX-REIMS version (recommended) or 2 for the latest one, not tested. You can change it later with osx-reims update-reims.

Then it prepares the computer:

• installs the system packages it needs;
• adds your user to the kvm, render and video groups;
• configures KVM (ignore_msrs), right away and for the next boots;
• installs Rust with rustup;
• downloads Reims vGPU into /opt/reims-vgpu and builds it.

On the first run, the build usually takes 5 to 15 minutes, depending on the computer and the internet connection.

5. Log out and back in, if asked#

When setup adds your user to groups, it says so at the end: log out and log back in (or restart the computer) before using OSX-REIMS.

6. Create your first VM#

Open OSX-REIMS from the applications menu, or run osx-reims in a terminal, and choose Create new VM. The step-by-step guide is in Your first VM.

If you already have macOS installed in another VM, such as on OSX-PROXMOX, choose Import VM disk to use its disk. See Importing a VM.

Check that everything is ready#

At any time, run:

osx-reims doctor

doctor checks everything setup prepares, without changing anything or asking for a password, and says how to fix each problem. At the end it prints the path of its log: that is the file to share in the support channel. The log contains no serial numbers or other VM identity data.

To check that the installed files are intact, run dpkg --verify osx-reims. No output means they are intact.

Running setup again#

You can run setup as many times as needed: steps that are already done are skipped, and on a ready computer it changes nothing.

Example without questions:

osx-reims setup -y --accept-license --tested

To see every option, run osx-reims setup --help.