Skip to content

README.md

Latest commit

 

History

History
61 lines (41 loc) · 1.63 KB

README.md

File metadata and controls

61 lines (41 loc) · 1.63 KB

Æsh Readline Shell WebSocket

In this example we're reusing ShellExample, but instead of using TerminalConnection we're setting up a WebSocket server connection listening on port 8080.

The web terminal uses xterm.js loaded from CDN for the browser-based terminal emulation.

Requirements

To compile and run you need:

  • JDK 11 or later
  • Apache Maven 3.5.+

Building

Launch the Maven build with:

mvn install

Running

For simplicity we use the Maven shade plugin to package all the dependencies into one jar, to run:

java -jar target/shell-websocket-0.1.jar

Then open your browser to http://localhost:8080 to connect to the WebSocket terminal.

Features

The web terminal includes:

  • Modern xterm.js terminal emulator
  • Fixed size 120x40 terminal
  • Connection status indicator
  • Cursor blinking
  • Text selection support

Customizing the Web Page

This example demonstrates how to use a custom HTML page instead of the default provided by terminal-http. The custom index.html is located at src/main/resources/org/acme/shellwebsocket/web/.

To use a custom resource path, configure the bootstrap:

NettyWebsocketTtyBootstrap bootstrap = new NettyWebsocketTtyBootstrap()
        .setHost("localhost")
        .setPort(8080)
        .setResourcePath("/org/acme/shellwebsocket/web");

You can also disable static file serving entirely for WebSocket-only mode:

bootstrap.setServeStaticFiles(false);

In WebSocket-only mode, you would serve your HTML from a separate web server and only use terminal-http for the WebSocket connection at /ws.