docs: Clarify SSH options and session recording (#3749)

* doc: Clarify SSH options and session recording

* docs: Copy edits based on review feedback

* docs: Update Note to match revision
jimlambrt-go-version
Dan Heath 2 years ago committed by GitHub
parent 3cd9c241f9
commit 8e985488ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -17,6 +17,16 @@ Recorded sessions are stored in an external storage bucket that you create.
Storing session recordings in a system external to Boundary means those recordings can be accessed, modified, deleted, and even restored independently of Boundary.
You can view any sessions that Boundary recorded in your storage provider or via the CLI.
When you view recorded sessions using the CLI or Admin UI, Boundary can convert the recording into other formats for playback.
Currently Boundary supports converting the recording of an individual SSH channel into an [asciicast](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md) format to play back an interactive SSH session.
The asciicast format is well suited for the playback of interactive shell activity.
However, some aspects of the recording cannot be translated into asciicast.
For example, if an SSH session uses the `RemoteCommand` option, or is used to `exec` a command, the command is not displayed in the asciicast.
The output of the command may be displayed, though.
If you use SSH for something other than an interactive shell, such as for file transfer, X11 forwarding, or port forwarding, Boundary does not attempt to create an asciicast.
In all cases, the SSH session is still recorded in the [BSR file](/boundary/docs/concepts/auditing/#bsr-directory-structure) and you can view the BSR file in the external storage bucket.
For more information about working with recorded sessions, refer to the following topics:
- [Find and view recorded sessions](/boundary/docs/operations/session-recordings/manage-recorded-sessions)

@ -9,6 +9,18 @@ description: |-
You can view a list of all recorded sessions, or if you know the ID of a specific recorded session, you can find any channels associated with that recording.
<Note>
The asciicast format is well suited for the playback of interactive shell activity.
However, some aspects of the recording cannot be translated into asciicast.
For example, if an SSH session uses the `RemoteCommand` option, or is used to `exec` a command, the command is not displayed in the asciicast.
The output of the command may be displayed, though.
If you use SSH for something other than an interactive shell, such as for file transfer, X11 forwarding, or port forwarding, Boundary does not attempt to create an asciicast.
In all cases, the SSH session is still recorded in the [BSR file](/boundary/docs/concepts/auditing/#bsr-directory-structure) and you can view the BSR file in the external storage bucket.
</Note>
<Tabs>
<Tab heading="CLI">
@ -72,7 +84,7 @@ You can find all recorded sessions in the UI from the global scope.
1. Select **View** next to the session recording you want to view.
The details page has information related to the session recording and
links to related inforation like user, target, and storage bucket.
links to related information like user, target, and storage bucket.
## Play back channel recording

Loading…
Cancel
Save