Commit 0ef99961 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch '214881-al-web-ide-terminal-docs' into 'master'

Improve user facing docs for Web IDE Interactive Terminals

Closes #214881

See merge request gitlab-org/gitlab!34573
parents 678c9c1b df8af801
...@@ -67,6 +67,6 @@ close the terminal window. ...@@ -67,6 +67,6 @@ close the terminal window.
![finished job with terminal open](img/finished_job_with_terminal_open.png) ![finished job with terminal open](img/finished_job_with_terminal_open.png)
## Interactive Web Terminals for the Web IDE **(ULTIMATE ONLY)** ## Interactive Web Terminals for the Web IDE
Read the Web IDE docs to learn how to run [Interactive Terminals through the Web IDE](../../user/project/web_ide/index.md). Read the Web IDE docs to learn how to run [Interactive Terminals through the Web IDE](../../user/project/web_ide/index.md#interactive-web-terminals-for-the-web-ide).
...@@ -213,16 +213,19 @@ to work: ...@@ -213,16 +213,19 @@ to work:
- The Runner needs to have - The Runner needs to have
[`[session_server]` configured properly](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section). [`[session_server]` configured properly](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section).
This section requires at least a `session_timeout` value (which defaults to 1800
seconds) and a `listen_address` value. If `advertise_address` is not defined, `listen_address` is used.
- If you are using a reverse proxy with your GitLab instance, web terminals need to be - If you are using a reverse proxy with your GitLab instance, web terminals need to be
[enabled](../../../administration/integration/terminal.md#enabling-and-disabling-terminal-support). **(ULTIMATE ONLY)** [enabled](../../../administration/integration/terminal.md#enabling-and-disabling-terminal-support). **(ULTIMATE ONLY)**
If you have the terminal open and the job has finished with its tasks, the 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 terminal will block the job from finishing for the duration configured in
[`[session_server].terminal_max_retention_time`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section) [`[session_server].session_timeout`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section)
until you close the terminal window. until you close the terminal window.
NOTE: **Note:** Not all executors are NOTE: **Note:** Not all executors are
[supported](https://docs.gitlab.com/runner/executors/#compatibility-chart) [supported](https://docs.gitlab.com/runner/executors/#compatibility-chart).
The [File Sync](#file-syncing-to-web-terminal) feature is supported on Kubernetes runners only.
### Web IDE configuration file ### Web IDE configuration file
...@@ -246,6 +249,8 @@ In the code below there is an example of this configuration file: ...@@ -246,6 +249,8 @@ In the code below there is an example of this configuration file:
```yaml ```yaml
terminal: terminal:
# This can be any image that has the necessary runtime environment for your project.
image: node:10-alpine
before_script: before_script:
- apt-get update - apt-get update
script: sleep 60 script: sleep 60
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment