MacOS

This guide will explain how to install Riptide under MacOS.

Note

MacOS is not supported as well as the Linux setup. Most of the downsides of Riptide on MacOS come from the Docker Desktop implementation for MacOS.

Riptide has some Performance optimizations to increase the performance on Mac, but it will still be slower than running it on Linux.

If you have experience with Docker or Python on MacOS, we’d love your support in making Riptide on MacOS even better!

Installing Requirements

This guide assumes you want to run Riptide in the most common set-up using the Docker Engine. To use Riptide you need to have the following installed:

Python is available for Mac machines using package managers.

Note

If you know what the best way of installing Python 3 is, please let us know by updating this documentation on Github.

There is a good chance you already have Python installed. Try running python3 --version to check.

Installing Riptide system-wide

Warning

It is currently unknown if sudo must or even can be used when installing Riptide system-wide. It seems to depend on the way Python is installed and also the MacOS version.

Please try with sudo first and see if this works. Make sure to remember if you installed with or without sudo, as you will need to update Riptide the same way, see below.

To install all Riptide components and the Docker implementation run the following command:

$ [sudo] pip3 install riptide-all

Sudo may or may not be required, see warning above.

You can test if Riptide is working:

Installing Riptide in a Virtualenv

Riptide can also be installed in a Virtualenv. This is only recommended for advanced Python users. Please make sure, to use the correct Python interpreter of your Virtualenv when setting up the proxy server.

Updating Riptide

To update Riptide, run

$ [sudo] riptide_upgrade

Make sure to use or not use sudo, depending on if you did during your initial installation. Failing to do so, WILL break your installation.

Configuring shared folders

Docker Desktop for MacOS only allows the virtual machine running the Docker daemon limited access to your machine.

The default configuration is not enough to use Riptide. Please open the settings of Docker and navigate to the Shared Folders tab. Make sure the following entries are present:

  • /Users
  • /Volumes
  • /private
  • /tmp
  • /var/folders
  • /usr/local/lib/python3.7 (Or wherever else Python is installed!)

Known issues under MacOS

  • Riptide currently uses the default Docker Desktop Mac daemon. This setup is known to have significantly worse performance than the Linux version. Riptide has some Performance optimizations to increase performance.
  • Due to the performance optimization settings, it might happen that changes to files are not immediately visible on the host system or the running containers. Some files are not updated on the host system at all (see Performance optimizations).

Note

If you are a Mac developer and want to improve this situation, please contact us. A possible solution for the perfomance issues may be something like a docker-sync implementation for Riptide.

Get help and join the community

If you need some support or just want to chat with the community, join our Slack workspace.

Next steps

The next pages of this documentation will explain how to finish the setup of Riptide, how to setup the Proxy server and how to install the Bash/Zsh integration. It will also teach you how to use the Riptide CLI and Proxy server.

Please make sure to read through all of the following pages of this documentation to properly setup Riptide.