Toolchains in Docker

1. Build the container

• Use the docker build line from the top of the Dockerfile:

  docker build -t clion/remote-cpp-env:0.5 -f Dockerfile.remote-cpp-env .

  Depending on your platform and your Docker setup, you may need to run it using sudo.

  This command will install the Ubuntu image and toolchain dependencies, set up SSH and create the user.

2. Run the container

1. Use the next command, docker run:

   docker run -d --cap-add sys_ptrace -p127.0.0.1:2222:22 --name clion_remote_env clion/remote-cpp-env:0.5

   In this line, -d runs the container as a daemon and --cap-add sys_ptrace adds the ptrace capability, which is necessary for debugging.

   The -p part specifies a port mapping. It exposes the default SSH port inside the container (22) as port 2222 on the host environment. You can specify any available port numbers here.

2. (Optional) You can create mapped volumes using the -v flag: -v /local/path/to/project:/remote/path/to/project

   After that, go to Settings / Preferences | Build, Execution, Deployment | Deployment, change the connection type to Local or mounted folder, and set the path mappings. See Full remote mode: Check and adjust the deployment configuration.

3. Clear cached SSH keys

• Last step of building and running the container is the ssh-keygen command, which clears any cached SSH keys. This is important since localhost ports are only temporarily mapped and can be reused by different containers.

  ssh-keygen -f "$HOME/.ssh/known_hosts" -R [localhost]:2222"

Create a Remote Host toolchain and the corresponding CMake profile

1. Follow the general instructions on creating a remote toolchain.

   In the Credentials field, set up the SSH configuration:

   • Host- localhost

   • Port- 2222

   • User name / Password- as specified in the Dockerfile

2. After establishing the connection, CLion attempts to detect the toolchain. Since the tools were installed into default locations, they will be detected automatically.

   If you change the apt-get part of the Dockefile to install the tools into other locations, provide the paths in the Make, C Compiler, C++ Compiler, and Debugger fields.

3. Create a CMake profile that uses the remote toolchain. Wait for the project to reload.

   note

   If you get an error message "CMake 3.15 or higher is required", it means that the container has an earlier version of CMake than your local project. You can change the version back at the top of the CMakeLists.txt file. As a more complicated alternative, build CMake of a higher version inside the container or use a different base image.