Windows Installation

This guide will explain how to install Riptide under Windows. This explains how to install it directly, without using WSL.

We generally recommend trying to use WSL instead. If you want to do that, follow the Linux instructions instead after setting up WSL.

Note

We can not offer any Windows specific support at the moment. New Riptide releases are not actively tested on Windows currently and may not work.

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:

Installing Riptide

Riptide should always be installed in a dedicated Python virtual environment to avoid conflicts between system packages and Riptide.

Choose a directory you want to store the virtualenv at, create a new virtualenv for Riptide and activate it:

cd virtualenvs  # This can be whereever you want
python3 -m venv riptide
source riptide\Scripts\activate.ps1 # Activates the virtualenv

Then, to install all Riptide components and the Docker implementation run the following command:

pip3 install riptide-all

After this you will need to re-activate the virtualenv every time you want to use Riptide.

You can test if Riptide is working:

You will then need to initialize the Riptide configuration if this is the first time using Riptide. If you used Riptide before skip this step (this will otherwise reset your configuration):

Initializing the configuration

riptide config-edit-user --factoryreset

SSL Certificate

Finally you want to import the SSL certificate authority. This allows your browser to trust the Riptide proxy server. See Import the SSL certificate authority for more details.

Updating Riptide

To update Riptide, run:

riptide_upgrade

After this make sure to restart the Proxy server.

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).

Next steps

You are now ready to use Riptide. Head to the user documentation for more information on how to use it: