Interactive Web Terminals
Introduced in GitLab 11.3.
Interactive web terminals give the user access to a terminal in GitLab for running one-off commands for their CI pipeline. Since this is giving the user shell access to the environment where GitLab Runner is deployed, some security precautions were taken to protect the users.
Configuration
Two things need to be configured for the interactive web terminal to work:
- The Runner needs to have
[session_server]
configured properly - If you are using a reverse proxy with your GitLab instance, web terminals need to be enabled
gitlab-runner
Helm chart,
but support is planned.Debugging a running job
docker
executor does not keep running
after the build script is finished. At that point, the terminal will automatically
disconnect and will not wait for the user to finish. Please follow this
issue for updates on
improving this behavior.Sometimes, when a job is running, things don’t go as you would expect, and it
would be helpful if one can have a shell to aid debugging. When a job is
running, on the right panel you can see a button debug
that will open the terminal
for the current job.
When clicked, a new tab will open to the terminal page where you can access the terminal and type commands like a normal shell.
If you have the terminal open and the job has finished with its tasks, the
terminal will block the job from finishing for the duration configured in
[session_server].session_timeout
until you
close the terminal window.
Interactive Web Terminals for the Web IDE
Read the Web IDE docs to learn how to run Interactive Terminals through the Web IDE.
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc