AppCode 2017.1 Help

Docker Integration

You can add Docker support to AppCode by installing the Docker integration plugin.

Prerequisites

Make sure that the following prerequisites are met:

  • Docker is installed, as described on the page Docker Docs. You can install Docker on the various platforms:
    • Windows
    • macOS
    • Linux (Ubuntu, other distributions-related instructions are available as well)
  • Before you start working with Docker, make sure that the Docker integration plugin is enabled. The plugin is bundled with AppCode and is activated by default. If the plugin is not activated, enable it on the Plugins page of the AppCode Preferences as described in Enabling and Disabling Plugins.

Overview of Docker support

The Docker integration plugin adds the following to AppCode:

  • Docker configurations. These are named sets of settings for accessing the Docker Engine API and Docker Compose.
    /help/img/idea/2017.1/docker_configuration.png

    You can create a Docker configuration in two ways:

  • Create Docker Deployment run/debug configurations. They let you download and build Docker images, and create and start Docker containers.

    To create a Docker Deployment run/debug configuration, do the following: Run | Edit Configurations | /help/img/idea/2017.1/add.png | Docker Deployment. See the run configuration settings.

  • Docker tool window (View | Tool Windows | Docker) that lets you manage your Docker images and containers.
  • Docker Registry configurations that represent your Docker image repository user accounts.

Working with Docker: Process overview

  1. Install Docker and start the Docker daemon (on Windows and macOS - along with the Docker VM in which it runs). For the instructions, see Get Started with Docker.
  2. Make sure that plugin is enabled.
  3. Create a Docker configuration. You can do that:
    • Separately, in the Settings / Preferences dialog: ⌃⌥S | Build, Execution, Deployment | Docker | /help/img/idea/2017.1/add.png | Docker.
    • When creating a Docker Deployment run configuration: Run | Edit Configurations | /help/img/idea/2017.1/add.png | Docker Deployment, etc.

    See the settings for a Docker configuration.

  4. Create a Docker Deployment run configuration.
  5. Execute the run configuration.
  6. Use the Docker Tool Window to manage your Docker images, containers and deployed applications.

See Also

Last modified: 26 July 2017