Skip to content

Commit

Permalink
doc: add new macos spice client doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fv3rdugo committed Feb 15, 2024
1 parent 97646da commit c0e344c
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 0 deletions.
92 changes: 92 additions & 0 deletions docs/docs/macos_spice_client.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
SPICE client setup for MacOS
============================

Virt-Viewer
===========
If you don't have brew installed, visit `Homebrew <https://brew.sh/>`_.

Follow this steps:

1. Install a working (and compiled) version of `virt-viewer <https://www.spice-space.org/osx-client.html>`_. You may view the homebrew package's upstream source on `GitHub <https://github.com/UPC/homebrew-virt-manager>`_.

::

brew tap UPC/homebrew-virt-manager
brew install virt-manager virt-viewer

2. Once that's installed should be able make a call **remote-viewer** with a spice file, for example 405.vv file downloaded from Ravada.

::

remote-viewer 405.vv

Associate SPICE files with remote viewer
========================================

We want remote-viewer to automatically start and open the session when we double click the VM entry in Ravada. To do that we need to first create a small helper application.

1. Launch Automator and select Application from the dropdown list, when prompted.

2. Search for shell and drag to the right. The contents:

::

/usr/local/bin/remote-viewer "$@"

Make sure to select as arguments for passing the input. Save as **~/Applications/ravada-spice-launcher.app**

3. Locate a ravada spice file .vv file or any file with .vv extension, and then hold down the Control key. With the Control key pressed, click on the .vv file, and then right click, open with, look for the .app file you just made, and check the Always Open With checkbox in the bottom of the dialog. This took a couple of tries for it to stick, but eventually remembered.

In Chrome, click on the small arrow on the list of downloads at the bottom, and select "Always open files of this type" and select ravada-spice-launcher app.

If everything is set up correctly you should be able to double-click on the VM and remote-viewer should start up and take care of the rest.

That's all. Enjoy Ravada.


There is another way to do it if you have some troubles, install only RemoteViewer.

RemoteViewer
============

::

brew install --cask remoteviewer

Usage:
remote-viewer console.vv

Binary path in my env is /opt/homebrew/bin/remote-viewer.

Remember to allow this application in Settings -> Privacy & Security

You can see this message:
"RemoteViewer.app" was blocked from use because it is not from an identified developer
Enable the button: Open Anyway



Problems
========

1. If you have some trouble, check your remote-viewer path. Maybe it is different from /usr/local/bin.

::
which remote-viewer

Other path can be: /opt/homebrew/bin/remote-viewer


2. You have a similar repo installed.

::

Error: Formulae found in multiple taps:

Fix with:

::
brew untap jeffreywildman/virt-manager
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Do you feel like giving us a hand? Here you have all the information you need as
docs/update_rollback
docs/windows_clients
docs/mac_clients
docs/macos_spice_client
docs/change_windows_driver_to_virtio
docs/Backup
docs/migrate_manual
Expand Down

0 comments on commit c0e344c

Please sign in to comment.