Documentation · Using OSX-REIMS
Updating and removing
Install a new OSX-REIMS version or remove it from your computer.
This documentation covers OSX-REIMS 0.6.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 downloaded with the Gerar meu link de download (Get my download link) button in the #osx-reims channel of the members' Discord, with the .deb package and its .sha256 checksum (see Getting OSX-REIMS). What changed in each version is in the Release notes.
The console's main screen shows one line when a newer version has been published. To check from the terminal:
osx-reims update --checkWith osx-reims update
Shut down every VM, download the new version's .deb from the channel and run:
osx-reims updateWithout a file, the command looks for osx-reims_*.deb in your Downloads and Desktop folders, in your home folder and in the current one, and asks which one to use. You can also name the file:
osx-reims update ~/Downloads/osx-reims_0.6.0_amd64.debIn the console the same thing is Maintenance › Update OSX-REIMS; after the update the console closes itself, so the next window opens on the version just installed.
The command checks the file, compares the versions and installs it with apt. It also checks the SHA-256 against the published one, which reaches the computer by a different route than the file does: a file whose version matches the published one but whose hash does not is not installed.
Note
Double-clicking the .deb does not work for an update: Ubuntu's App Center shows a package whose name is already installed as "Installed", without comparing the versions, and the button stays grey. That is why osx-reims update exists.
With apt
The older way still works, and it is the only one for a first installation:
-
Download both files into the same folder, open a terminal there and verify the download:
sha256sum -c osx-reims_<version>_amd64.deb.sha256 -
Install the new package over the current one:
sudo apt install ./osx-reims_<version>_amd64.debIf 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.
After updating
Do what the installation asks at the end:
osx-reims setup, when the new version brings a new VM boot program or a new license text that must be accepted. It can be run as many times as needed and changes nothing that is already in place;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 an apt installation; osx-reims update requires all of them to be shut down, because the package replaces files a running VM is using. Your VMs, downloaded installers and logs are kept.
Tip
Coming from 0.4.1: with all VMs shut down, install the package and run osx-reims update-reims --tested. 0.6.0 uses the rewritten Reims vGPU, and that command updates it, builds it again and installs the new VM boot program. The license stays accepted, and the VMs keep their disks, identity and settings. The GPU memory setting is gone. See The rewritten Reims vGPU.
Removing OSX-REIMS
sudo apt remove osx-reimsRemoving 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/osx-reims/backup |
The VMs' backups |
/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.
Important
If you turned the VMs' network bridge on, run osx-reims network bridge off before removing the package: removing it does not undo the bridge, because the computer may be using that same network.
If your terminal is Ptyxis, the launcher also keeps the console window settings in ~/.local/state/osx-reims/ptyxis.
If a VM had autostart, the service stops doing anything once the package is removed, because the program it would call is no longer there. Ubuntu's automatic login, if you turned it on, is a setting of the system itself and stays on: turn it off in Ubuntu's Settings, or with osx-reims autostart off --no-login before removing the package.
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 the memory one in /etc/sysctl.d/60-osx-reims.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.