Skip to content
OSX-REIMS
Documentation: Advanced configuration

Documentation · Help

Advanced configuration

Folders, environment variables, /etc/osx-reims.conf and the OpenCore choice.

Alpha

This documentation covers OSX-REIMS 0.3.0, alpha software. Commands and options may change between versions; when in doubt, check osx-reims --help on the installed version.

Most people do not need to change anything here. These options are for keeping VMs somewhere else, using Reims vGPU from another folder or understanding the advanced boot choices.

Default folders

Folder Contents
/opt/osx-reims/ The program, installed by the package
/opt/osx-reims/cache/, full/, logs/ and state/ Installers, full images, logs and state, created by setup for your user
/opt/reims-vgpu/ Reims vGPU (REIMS_ROOT)
/opt/reims-vgpu/vm/disks/rails/ The VMs (RAILS_DIR)

Environment variables

Variable What it sets Default
REIMS_ROOT The Reims vGPU folder /opt/reims-vgpu
RAILS_DIR The VM folder <REIMS_ROOT>/vm/disks/rails
MACRECOVERY Alternative path to macrecovery.py, which downloads the recovery from Apple The one shipped in the package
QMP_TIMEOUT Seconds to wait for each control command sent to a running VM 5
NO_COLOR Turns off terminal colors Not set

Example, for a single command:

RAILS_DIR=/mnt/vms/rails osx-reims list

The /etc/osx-reims.conf file

To set REIMS_ROOT, RAILS_DIR or REIMS_VGPU_REF permanently, create the optional /etc/osx-reims.conf file, with one KEY=VALUE line per option:

# VM folder on another disk
RAILS_DIR=/mnt/vms/rails
  • The file is used only when it is owned by root and not writable by other users. That is why you create it with sudo.
  • Lines starting with # are comments, and one pair of quotes around the value is accepted.
  • Other keys are ignored.
  • Environment variables take precedence over the file.
  • Each log's header says whether the file was used or ignored, and why.

To choose the Reims vGPU version, prefer osx-reims update-reims over setting REIMS_VGPU_REF. See Reims vGPU version.

Important

Changing RAILS_DIR does not move existing VMs: they stay in the old folder and no longer show up. The new folder must be writable by your user.

Which OpenCore starts the VM

Every VM comes with its own OpenCore boot disk. After the first start, start asks which OpenCore to use:

Option --opencore What it is
VM boot disk image The OpenCore that came with the VM. It is the default and the recommended choice
macOS disk esp The OpenCore you installed in the EFI partition of the macOS disk
  • macOS disk only works after you install OpenCore into the macOS disk's EFI yourself, and it is only offered for VMs that went through their first start.
  • The choice is saved and becomes that VM's default.
  • Each OpenCore carries its own configuration. Switching between them can change the identity macOS sees, such as the serial number, and with it iCloud, iMessage and FaceTime. start warns you before starting.
  • When you switch back to VM boot disk, the firmware boot order is reset so the VM starts from its own boot disk again.

Running without questions

Commands accept -y to run without questions, using the option values or the defaults. To see a VM's boot command without starting it:

osx-reims start 10 --dry-run

Every option is in Commands.