Windows

This guide will explain how to install Riptide under Windows.

Note

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

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

Also we can not offer any Windows specific support at the moment.

If you have experience with Docker or Python on Windows, we’d love your support in making Riptide on Windows 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:

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

Installing Riptide system-wide

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

$ pip3 install riptide-all

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

$ riptide_upgrade

Configuring shared drives

When installing Riptide on a drive other than C:, or when using projects from other drives, you may need to share this drive with the Docker VM. A notice about this should automatically open in this case.

Known issues under Windows

  • Riptide currently uses the default Docker Desktop Windows 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 Windows 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 or using Docker with WSL2 instead of using Docker Desktop. If you do, please share your experience!

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.