Skip to content

Updated doc for default connection mode #7011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kmartens27 merged 3 commits into from
Jan 16, 2024
Merged

Updated doc for default connection mode #7011

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d70968
Updated doc for default connection mode
Harishrao13 Jan 15, 2024
93e7bdb
Updated doc for default connection mode.
Harishrao13 Jan 16, 2024
29aad1b
Merge branch 'jenkins-infra:master' into master
Harishrao13 Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions content/doc/book/managing/cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,11 +220,17 @@ Summaries of other general options can be displayed by running the client with n
=== Client connection modes

There are three basic modes in which the client may be used, selectable by global option:
`-http`, `-webSocket`, and `-ssh`.
`-webSocket`, `-http` and `-ssh`.

==== WebSocket connection mode

This is the default mode, though you may pass the `-webSocket` option explicitly for clarity.
The advantage is that a more standard transport is used, avoiding problems with many reverse proxies or the need for special proxy configuration.

==== HTTP connection mode

This is the default mode, though you may pass the `-http` option explicitly for clarity.
Starting from Jenkins 2.391, the default mode is `-webSocket`.
To use the HTTP mode, you must explicitly pass the `-http` option.

Authentication is preferably with an `-auth` option, which takes a `username:apitoken` argument.
Get your API token from `/me/configure`:
Expand Down Expand Up @@ -275,12 +281,6 @@ This mode is known to not work reliably or at all when using certain reverse pro
Prefer WebSocket mode.
====

==== WebSocket connection mode

In Jenkins 2.217 and above, the `-webSocket` mode may be used as an alternative to `-http`.
The advantage is that a more standard transport is used,
avoiding problems with many reverse proxies or the need for special proxy configuration.

==== SSH connection mode

Authentication is via SSH keypair.
Expand Down