With VS Code you can:
docksal/clithe same way you’d use them with
This integration requires
docksal/cli v2.10.0 or greater.
To enable the IDE integration for a project:
# Remove/reset the cli container (only necessary for an existing project stack) fin project remove cli # Enable IDE fin config set --env=local IDE_ENABLED=1 # Apply new stack configuration fin project start
To enable for other developers within the project, remove the
--env=local option from the above command and commit
the changes in
docksal.env into git.
After enabling, the IDE can be accessed at
When enabling the IDE on a publicly accessible Docksal environment, ensure the IDE is password protected:
fin config set --env=local IDE_PASSWORD="mypassword"
When no value is set, a password is not required to access the IDE.
XDebug VS Code extension is pre-installed and pre-configured, however the XDebug PHP extension is not enabled by default.
To enable the XDebug PHP extension:
fin config set --env=local XDEBUG_ENABLED=1 fin project start
To debug web pages in the IDE:
Similarly, to debug CLI scripts in the IDE:
IDE runs in a dedicated container in the project stack. The
ide container and the
cli container use the same image
but run different processes inside. They also share the
/home/docker volume. Changes in the
docker user’s home
directory will be in sync in both containers (e.g., installing a different NodeJS version). However, installing global
apt-get or making other system level changes inside one container will not have effect on the other one.
With IDE enabled, you will not be able to individually reset
ide containers. To workaround this, remove
both containers, then start/update the project stack:
fin project remove cli ide fin project start
Was this page helpful?
Thanks for the feedback. If you have a specific, answerable question about how to use Docksal, ask it in Discussions on GitHub. Open an issue if you want to report a problem or suggest an improvement. You can also contribute changes to this page using the link in the top right corner.