RubyMine 2017.2 Help

Configuring Remote Interpreters via Docker Compose

Prerequisite

Before you start working with Docker Compose, make sure that the Docker Compose Integration plugin is enabled. The plugin is bundled with RubyMine and is activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Limitation

As of this writing, Docker Compose Integration in RubyMine is supported on macOS and Linux only.

Using Docker Compose to configure a remote interpreter

To configure a remote Ruby interpreter, follow these steps:

  1. In the Ruby SDK and Gems page of the Settings/Preferences dialog box, click /help/img/idea/2017.2/add.png .
  2. From the drop-down list, choose New remote....

    The dialog box Configure Remote Ruby Interpreter opens.

  3. In this dialog box that opens, do the following:
    1. Click the radio button Docker Compose.
      /help/img/idea/2017.2/rm_choose_docker_compose.png
    2. Choose the desired server from the drop-down list, or click New.
    3. In the Configuration file(s) field, specify the required configuration files, by clicking /help/img/idea/2017.2/browseButton.png.

      Use the toolbar /help/img/idea/2017.2/add.png, /help/img/idea/2017.2/delete.png, /help/img/idea/2017.2/arrowUp.png, /help/img/idea/2017.2/arrowDown.png to make up the list of coonfiguration files.

      Note that if the path points to a specific file (for example, docker-compose.yml), then this configuration will be used. If the path points to a directory, then the configuration is defined by the file docker-compose.yml and (if exists) docker-compose.override.yml.

    4. In the field Environment variables, specify the environment variables of the container . Click the browse button /help/img/idea/2017.2/browseButton.png next to this field, and specify the required environment variables using the toolbar buttons /help/img/idea/2017.2/add.png, /help/img/idea/2017.2/delete.png, /help/img/idea/2017.2/copy.png, /help/img/idea/2017.2/paste.png.
    5. Choose the service that represent your project.
    6. The Ruby interpreter path field displays the path to the desired Ruby executable. You can accept default, or specify a different one.
  4. Click OK in the Configure Remote Ruby Interpreter dialog box. The configured remote interpreter is added to the list.

From this point, autocompletion, code inspections, as well as other features, will be driven by the interpreter from the Docker container derived from the service description in docker-compose.yml file.

Debugging an application with Docker Compose

If you want to debug your application in Docker Compose container, please make sure that the following prerequisites are met:

  • The gems, required to make the RubyMine debugger work, are added to the Gemfile of your project: ruby-debug-ide and debase

    For example:

    gem 'debase', '0.2.2.beta8' gem 'ruby-debug-ide'
  • The command docker-compose build, required to install these gems to your project, has been run in the Terminal.
  • The command docker ps has been run in the Terminal to make sure your web app is not currently running. If it is, stop your container.

See Also

Reference:

Language and Framework-Specific Guidelines:

Last modified: 21 July 2017