diff options
| author | Adam Niedzielski <adamsunday@gmail.com> | 2017-01-26 19:16:50 +0100 |
|---|---|---|
| committer | Adam Niedzielski <adamsunday@gmail.com> | 2017-02-06 11:49:30 +0100 |
| commit | 5d3816652e13cde6bf5e9de814d2c9d1e6593601 (patch) | |
| tree | f6137cb0baeb01330a1729d00c059988ced600ee /doc | |
| parent | 572fb0be9b1d45437b7c0ed1000399657f471ec7 (diff) | |
| download | gitlab-ce-5d3816652e13cde6bf5e9de814d2c9d1e6593601.tar.gz | |
Introduce maximum session time for terminal websocket connectionterminal-max-session-time
Store the value in application settings.
Expose the value to Workhorse.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/integration/terminal.md | 10 | ||||
| -rw-r--r-- | doc/api/settings.md | 7 |
2 files changed, 15 insertions, 2 deletions
diff --git a/doc/administration/integration/terminal.md b/doc/administration/integration/terminal.md index 3fbb13704aa..11444464537 100644 --- a/doc/administration/integration/terminal.md +++ b/doc/administration/integration/terminal.md @@ -71,5 +71,15 @@ When these headers are not passed through, Workhorse will return a `400 Bad Request` response to users attempting to use a web terminal. In turn, they will receive a `Connection failed` message. +## Limiting WebSocket connection time + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8413) +in GitLab 8.17. + +Terminal sessions use long-lived connections; by default, these may last +forever. You can configure a maximum session time in the Admin area of your +GitLab instance if you find this undesirable from a scalability or security +point of view. + [ce-7690]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7690 [kubservice]: ../../user/project/integrations/kubernetes.md) diff --git a/doc/api/settings.md b/doc/api/settings.md index f86c7cc2f94..ca6b9347877 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -46,7 +46,8 @@ Example response: "koding_enabled": false, "koding_url": null, "plantuml_enabled": false, - "plantuml_url": null + "plantuml_url": null, + "terminal_max_session_time": 0 } ``` @@ -84,6 +85,7 @@ PUT /application/settings | `disabled_oauth_sign_in_sources` | Array of strings | no | Disabled OAuth sign-in sources | | `plantuml_enabled` | boolean | no | Enable PlantUML integration. Default is `false`. | | `plantuml_url` | string | yes (if `plantuml_enabled` is `true`) | The PlantUML instance URL for integration. | +| `terminal_max_session_time` | integer | no | Maximum time for web terminal websocket connection (in seconds). Set to 0 for unlimited time. | ```bash curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/application/settings?signup_enabled=false&default_project_visibility=1 @@ -118,6 +120,7 @@ Example response: "koding_enabled": false, "koding_url": null, "plantuml_enabled": false, - "plantuml_url": null + "plantuml_url": null, + "terminal_max_session_time": 0 } ``` |