Skip to content
OSX-REIMS
Documentation: Updating and removing

Documentation · Using OSX-REIMS

Updating and removing

Install a new OSX-REIMS version or remove it from your computer.

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.

Updating OSX-REIMS

Each new version is published in the #osx-reims channel of the members' Discord, with the .deb package and its .sha256 checksum. What changed in each version is in the Release notes.

  1. Download both files into the same folder, open a terminal there and verify the download:

    sha256sum -c osx-reims_<version>_amd64.deb.sha256

  2. Install the new package over the current one:

    sudo apt install ./osx-reims_<version>_amd64.deb

    If apt finishes with a line starting with Notice: Download is performed unsandboxed as root, that is fine: it is normal when the file is in your home folder.

  3. Do what the installation asks at the end:

    • osx-reims setup, when the new version brings a new license text that must be accepted;
    • osx-reims update-reims, with all VMs shut down, when Reims vGPU must be updated too (see Reims vGPU version).

Running VMs are not affected by the installation. Your VMs, downloaded installers and logs are kept.

Removing OSX-REIMS

sudo apt remove osx-reims

Removing deletes only the program's files. Nothing you created is deleted:

Path What it is
/opt/osx-reims/cache, full, logs and state Downloaded installers, full images, logs and the setup state
/opt/reims-vgpu Reims vGPU and the VMs, in vm/disks
~/.cargo and ~/.rustup Rust

The message at the end of the removal lists these paths. Delete them yourself if you no longer need them.

If your terminal is Ptyxis, the launcher also keeps the console window settings in ~/.local/state/osx-reims/ptyxis.

Caution

The VMs live inside /opt/reims-vgpu. Deleting that folder deletes every VM and the macOS installed in them, for good.

To remove the Rust installed by setup, use rustup self uninstall. sudo apt purge osx-reims also removes the KVM settings in /etc/modprobe.d/osx-reims-kvm.conf, and still does not delete your data. Your user stays in the kvm, render and video groups.

When the membership ends

When your membership ends, the license stops being valid and OSX-REIMS must be removed from the computer. The VMs and other data you created remain yours. See License.