Wait for device connection -> Web-Based SSH Terminal

Web-Based SSH Terminal

Summary

The Web-Based SSH Terminal page allows you to establish a secure connection to your devices and interact with them using Linux commands. You can send commands directly, view their output in real-time, and manage various aspects of your SSH session. This tool is designed for users who need direct command-line access to their connected devices.

Page Access

You can access this page by navigating to: /devices_configure

Page Functionalities

Terminal Display Area

This is the main area where you will see the output of the commands you send to your device. It functions like a standard command-line interface, displaying text responses from the device.

Command Input Field

Located at the bottom of the terminal, this field is where you type the Linux commands you wish to execute on your connected device. After typing, you can send the command using the "Send" button or by pressing the Enter key.

Send Button

Next to the command input field, this button sends the command you've typed to your device for execution.

Terminal Menu Bar

At the top of the terminal, you'll find a menu bar with various controls. This bar can be collapsed to save space or expanded to show all options.

  • Collapse/Expand Menu Bar: Use the arrow icons (e.g., an arrow pointing left for collapse, or an arrow pointing right for expand) to hide or show the menu options.
  • Switch Terminal Window (if not a shared device): This feature allows you to manage up to four independent terminal sessions simultaneously. Click the window icon (a dock window symbol) to reveal numbered circles (1, 2, 3, 4); click a number to switch to that terminal window.
  • Activate / Deactivate Administrator User (if not a shared device): Click the shield icon (a shield with an account symbol) to activate or deactivate administrator privileges for your current session.
  • Copy Selected Text (Keyboard Shortcut: Ctrl+C): Select any text within the terminal display with your mouse, then click this icon (a double-page symbol for copying) or press Ctrl+C (Cmd+C on Mac) on your keyboard to copy it to your clipboard.
  • Paste Text (Keyboard Shortcut: Ctrl+V): Click this icon (a clipboard symbol for pasting) or press Ctrl+V (Cmd+V on Mac) on your keyboard while your cursor is in the command input field to paste text from your clipboard.
  • Disconnect Terminal Session: Click the exit icon (an exit door symbol) to end your current SSH connection to the device.

Chat Button

Located on the right side of the menu bar, this icon (a message bubble symbol) allows you to switch from the direct SSH terminal to an intelligent chat interface for device interaction.

Shared Device Banner

If you are connected to a shared or demo device, a blue banner might appear at the top of the terminal. This banner provides important information regarding access restrictions, such as limitations on sending commands.

Terminal Initializing Overlay

When the terminal is first connecting and loading, a dark overlay with a loading indicator and the message "Initializing terminal" will be displayed. This indicates that the system is establishing the connection to your device.

Scenario Executions

Possible usage steps within this page

Scenario 1: Sending a Basic Command

  1. Ensure you are connected to your device via the Web-Based SSH Terminal.
  2. Locate the "Enter a command" input field at the bottom of the terminal.
  3. Type a command, for example, ls -l, to list files in detail.
  4. Press the Enter key on your keyboard or click the "Send" button.
  5. Observe the terminal display; you should see the detailed list of files and folders appear.

Scenario 2: Copying and Pasting Terminal Output

  1. After executing a command (e.g., cat /etc/os-release) and seeing its output, use your mouse to select a portion of the text in the terminal display.
  2. Click the "Copy" icon (a double-page symbol for copying) in the terminal menu bar, or press Ctrl+C (Cmd+C on Mac) on your keyboard.
  3. Move your cursor to the command input field.
  4. Click the "Paste" icon (a clipboard symbol for pasting) in the terminal menu bar, or press Ctrl+V (Cmd+V on Mac) on your keyboard.
  5. The selected text from the terminal should now appear in your command input field.

Scenario 3: Switching Terminal Windows (for non-shared devices)

  1. If you are not on a shared device, click the "Switch Terminal Window" icon (a dock window symbol) in the menu bar.
  2. Four numbered circles (1, 2, 3, 4) will appear below the menu bar.
  3. Click on a different number, for example, "2".
  4. The terminal display will switch to show the session associated with Terminal Window 2. You can now execute different commands in this new context.

Scenario 4: Disconnecting Your Session

  1. When you are finished with your terminal session, locate the "Disconnect Terminal Session" icon (an exit door symbol) in the terminal menu bar.
  2. Click this icon.
  3. A brief message, "Disconnecting terminal session," will appear, and your secure connection to the device will be terminated.

Scenario 5: Switching to Intelligent Chat

  1. Locate the "Chat" icon (a message bubble symbol) on the far right of the terminal menu bar.
  2. Click this icon.
  3. The entire view will transition from the direct command-line terminal to an intelligent chat interface, allowing you to interact with your device through conversational prompts.

Possible errors which may occur on this page

Error: "Error sending command - try again (press enter)"

This message appears at the bottom of the screen if a command you tried to send could not be delivered to the device. This usually happens due to a temporary network interruption between your device and the server, or if your session has timed out. To resolve this, ensure your network connection is stable and try pressing Enter again to resend the last command. If the issue persists, consider disconnecting and reconnecting to the device.

Error: Terminal Becomes Unresponsive (Session Expired)

If you leave the terminal open for an extended period without activity, or if there's a problem maintaining the secure connection, the terminal might stop responding to your commands. This is often a security measure to protect your device. If this occurs, you will need to disconnect the current session (using the "Disconnect Terminal Session" icon) and re-establish a new connection to regain control.

Up to User Manual Main Page