JetBrains CodeCanvas 2024.1 Help

IDE and IDE Components

CodeCanvas lets you flexibly configure the IDE for user dev environments. You can specify the IDE and its version, the plugins that will be installed, and the VM options that will be used to run the IDE.

IDE and IDE version

You can specify the IDE and its version when creating a dev environment template. If you specify Default as the IDE version, dev environments will use the version set by the system administrator. By default, the Default version means the latest release version. Learn more

In an already existing dev environment template, you can change the IDE version but not the IDE itself.

Change IDE version

VM options

In some cases, you might need to change the configuration of Java Virtual Machine (JVM) your IntelliJ-based IDE runs on. For example, increase the maximum memory heap size allocated for the IDE.

To configure VM options, use the Advanced | VM options section of the dev environment template. Specify one option per line. For example:

-Xms2048m -Xmx4096m

Configure IDE settings (IntelliJ-based IDEs)

There are two types of settings in IntelliJ-based IDEs:

  • Project settings

    The .idea directory in the project directory contains project settings like the list of modules, run configurations, file encodings, and others. As this directory is stored in the source code, your project settings will be automatically applied to the IDE in a dev environment.

  • Personal settings

    Personal IDE settings include the IDE theme, keymap, code style, and others. We recommend that developers apply the personal settings themselves using the Settings Sync feature of the IDE. Learn more

Pre-install IDE plugins (IntelliJ-based IDEs)

We recommend that you use lifecycle scripts to install plugins in the IDE. In the On initialization script, you can download and install the plugins from a file storage. When a user creates a dev environment, the plugins will be installed automatically.

  1. In JetBrains Marketplace, find the plugin you need.

  2. Copy the plugin's download link.

    Copy plugin link
  3. In your project repository, create a script (e.g., installPlugins.sh) that installs the plugins. For example, the script can look like this:

    # Download the plugin curl -L -o plugin.zip "https://plugins.jetbrains.com/plugin/download?rel=true&updateId=493520" # Unzip the plugin to the plugins directory of the IDE unzip plugin.zip -d $CODECANVAS_IDE_HOME/ide-plugins/ # Remove the .zip file rm $CODECANVAS_IDE_HOME/ide-plugins/plugin.zip
  4. Push the script to the project repository.

  5. Open the Lifecycle scripts section of the dev environment template.

  6. Enable the On initialization script and specify the path to the script that installs the plugins. For example: ./installPlugins.sh

Last modified: 17 May 2024