webssh2_client 0.2.20 → 0.2.22

package/README.md

@@ -3,7 +3,7 @@
 WebSSH2 Client is a web-based SSH client that allows users to connect to SSH servers directly from their web browsers. It's built using modern web technologies and provides a seamless, secure SSH experience.
 
 # EXPERIMENTAL
-The current status is experimental, and this first version is a refactor of webssh2 v0.2.x to be compatible with a refactor of the same version of webssh2 as a stand-alone server-side component for BIG-IP running Node.js v6.9.1.
+The current status is experimental, and this first version is a refactor of webssh2 v0.2.x to be compatible with a refactor of the same version of webssh2 as a stand-alone server-side component  running Node.js v6.9.1.
 
 The intention is to harmonize the latest release of webssh2 by splitting out the client and server as separate repos (webssh2-client and webssh2-server) but joining them both together as modules in a parent webssh2 in an attempt to provide backward compatibility.
 
@@ -78,22 +78,11 @@ window.webssh2Config = {
     sshTerm: 'xterm-color',  // Terminal type
     readyTimeout: 20000,  // SSH connection timeout (ms)
   },
-  terminal: {
-    cursorBlink: true,  // Whether the cursor should blink
-    scrollback: 10000,  // Number of rows to keep in scrollback
-    tabStopWidth: 8,  // Tab width
-    bellStyle: 'sound',  // Terminal bell style ('sound' or 'none')
-    fontSize: 14,  // Font size in pixels
-    fontFamily: 'courier-new, courier, monospace',  // Font family
-    letterSpacing: 0,  // Letter spacing
-    lineHeight: 1,  // Line height
-  },
   header: {
     text: null,  // Custom header text
     background: 'green',  // Header background color
   },
-  autoConnect: false,  // Whether to connect automatically
-  logLevel: 'info',  // Logging level ('debug', 'info', 'warn', 'error')
+  autoConnect: false  // Whether to connect automatically
 };
 ```
 
@@ -131,18 +120,7 @@ When `autoConnect` is not used, ensure your server is configured to prompt for o
 
 ### Customization Examples
 
-1. Changing terminal appearance:
-   ```javascript
-   window.webssh2Config = {
-     terminal: {
-       fontSize: 16,
-       fontFamily: 'Fira Code, monospace',
-       cursorBlink: false
-     }
-   };
-   ```
-
-2. Setting a custom header:
+1. Setting a custom header:
    ```javascript
    window.webssh2Config = {
      header: {
@@ -152,7 +130,7 @@ When `autoConnect` is not used, ensure your server is configured to prompt for o
    };
    ```
 
-3. Configuring for a specific SSH server with auto-connect:
+2. Configuring for a specific SSH server with auto-connect:
    ```javascript
    window.webssh2Config = {
      ssh: {
@@ -251,64 +229,87 @@ The WebSSH2 client supports various URL parameters to customize the SSH connecti
 - `password`: The password for SSH authentication (not recommended for production use).
   - Example: `?password=secretpassword`
 
-### Terminal Configuration
+### UI Customization
 
-- `sshTerm`: The terminal type to request (default is "xterm-color").
-  - Example: `?sshTerm=xterm-256color`
+- `header`: Custom text to display in the header.
+  - Example: `?header=My%20SSH%20Session`
 
-- `readyTimeout`: The timeout (in milliseconds) for the SSH handshake (default is 20000).
-  - Example: `?readyTimeout=30000`
+- `headerBackground`: Background color for the header.
+  - Example: `?headerBackground=red`
 
-- `cursorBlink`: Whether the cursor should blink (true/false).
-  - Example: `?cursorBlink=true`
+### Usage Example
 
-- `scrollback`: The number of lines to keep in the scrollback buffer (default is 10000).
-  - Example: `?scrollback=5000`
+A full URL with multiple parameters might look like this:
 
-- `tabStopWidth`: The width of tab stops (default is 8).
-  - Example: `?tabStopWidth=4`
+```
+http://localhost:2222/ssh/host/192.168.1.100?port=2222&header=Production%20Server&headerBackground=red&fontSize=14&bellStyle=none
+```
 
-- `bellStyle`: The style of the terminal bell ("sound" or "none", default is "sound").
-  - Example: `?bellStyle=none`
+This URL would connect to a SSH server at 192.168.1.100 on port 2222, with a red header displaying "Production Server", using a 14px font size and turning off the audible bell.
 
-### Display Options
+Note: Be cautious about including sensitive information like passwords in URL parameters, especially in production environments.
 
-- `fontSize`: The font size for the terminal (in pixels).
-  - Example: `?fontSize=14`
+## Terminal Configuration
 
-- `fontFamily`: The font family to use for the terminal.
-  - Example: `?fontFamily=Consolas,Monaco,Lucida%20Console,Liberation%20Mono,DejaVu%20Sans%20Mono,Bitstream%20Vera%20Sans%20Mono,Courier%20New,monospace`
+WebSSH2 Client allows users to customize their terminal experience through a set of configurable options. These settings are stored in the browser's localStorage under the key `webssh2.settings.global`, ensuring your preferences persist across sessions.
 
-- `letterSpacing`: The letter spacing for the terminal font.
-  - Example: `?letterSpacing=1`
+### Accessing Terminal Settings
 
-- `lineHeight`: The line height for the terminal.
-  - Example: `?lineHeight=1.2`
+You can access the terminal configuration in two ways:
 
-### UI Customization
+1. **From an Active Session:**
+   - Click on the menu icon (☰) in the bottom-left corner of the terminal.
+   - Select "Settings" from the dropdown menu.
 
-- `header`: Custom text to display in the header.
-  - Example: `?header=My%20SSH%20Session`
+2. **During Login:**
+   - In the login dialog, click on the gear icon (⚙️) next to the "Connect" button.
 
-- `headerBackground`: Background color for the header.
-  - Example: `?headerBackground=red`
+### Available Settings
 
-### Debugging
+The terminal settings dialog offers the following customization options:
 
-- `logLevel`: Sets the logging level for debugging purposes.
-  - Example: `?logLevel=debug`
+1. **Font Size**
+   - Range: 8-72 pixels
+   - Adjusts the size of the text in the terminal.
 
-### Usage Example
+2. **Font Family**
+   - Specifies the font used in the terminal.
+   - Example: "Courier New, monospace"
 
-A full URL with multiple parameters might look like this:
+3. **Cursor Blink**
+   - Options: On / Off
+   - Determines whether the cursor blinks in the terminal.
 
-```
-http://localhost:2222/ssh/host/192.168.1.100?port=2222&header=Production%20Server&headerBackground=red&fontSize=14&bellStyle=none
-```
+4. **Scrollback**
+   - Range: 1-200000 lines
+   - Sets the number of lines kept in the terminal's scrollback buffer.
 
-This URL would connect to a SSH server at 192.168.1.100 on port 2222, with a red header displaying "Production Server", using a 14px font size and turning off the audible bell.
+5. **Tab Stop Width**
+   - Range: 1-100 spaces
+   - Defines the width of tab stops in the terminal.
 
-Note: Be cautious about including sensitive information like passwords in URL parameters, especially in production environments.
+6. **Bell Style**
+   - Options: Sound / None
+   - Configures the audible bell behavior in the terminal.
+
+### Applying Settings
+
+After adjusting your preferences:
+
+1. Click "Save" to apply the new settings.
+2. The changes will take effect immediately for the current session and all future sessions.
+3. Click "Cancel" to close the dialog without saving changes.
+
+### Resetting to Defaults
+
+To reset all settings to their default values:
+
+1. Clear your browser's localStorage for the WebSSH2 Client site.
+2. Refresh the page.
+
+### Note on Persistence
+
+These settings are stored locally in your browser. If you use WebSSH2 Client on a different device or browser, you'll need to reconfigure your preferences.
 
 ## Debugging
 

package/client/index.js

@@ -1,5 +1,5 @@
-// webssh2-client
-// /client/index.js
+// client
+// client/index.js
 const path = require('path');
 
 module.exports = {

package/client/public/client.htm

@@ -1,4 +1,4 @@
-<!-- Version Version 0.2.20 - 2024-08-18T12:58:07.614Z - 284a3fb -->
+<!-- Version Version 0.2.22 - 2024-08-19T18:58:58.568Z - 4c2b9ba -->
 <!-- webssh2-client -->
 <!-- /client/src/client.htm -->
 <!DOCTYPE html>
@@ -38,10 +38,10 @@
         <p id="errorMessage"></p>
       </div>
     </dialog>
-    <dialog id="terminalOptionsDialog" class="modal">
+    <dialog id="terminalSettingsDialog" class="modal">
       <div class="modal-content">
-        <h2>Terminal Options</h2>
-        <form id="terminalOptionsForm" class="pure-form pure-form-stacked">
+        <h2>Terminal Settings</h2>
+        <form id="terminalSettingsForm" class="pure-form pure-form-stacked">
           <fieldset>
             <label for="fontSize">Font Size</label>
             <input type="number" id="fontSize" name="fontSize" min="8" max="72" required>
@@ -68,7 +68,7 @@
             </select>
                 
             <button type="submit" class="pure-button pure-button-primary">Save</button>
-            <button type="button" id="closeTerminalOptionsBtn" class="pure-button">Cancel</button>
+            <button type="button" id="closeterminalSettingsBtn" class="pure-button">Cancel</button>
           </fieldset>
         </form>
       </div>
@@ -88,7 +88,7 @@
             <button id="downloadLogBtn" class="menu-button"><i class="fas fa-download fa-fw"></i> Download Log</button>
             <button id="replayCredentialsBtn" class="menu-button"><i class="fas fa-key fa-fw"></i> Credentials</button>
             <button id="reauthBtn" class="menu-button"><i class="fas fa-key fa-fw"></i> Switch User</button>
-            <button id="terminalOptionsBtn" class="menu-button"><i class="fas fa-cog fa-fw"></i> Settings</button>
+            <button id="terminalSettingsBtn" class="menu-button"><i class="fas fa-cog fa-fw"></i> Settings</button>
           </div>
         </div>
         <div id="footer"></div>