https://github.com/klpod221/ssh-client

// Simple SSH Client run on web browser
https://github.com/klpod221/ssh-client

ejs express express-js expressjs node node-js nodejs nodemon socket-io socketio ssh ssh-client ssh2 xterm xterm-js xtermjs

Last synced: 27 days ago
JSON representation

// Simple SSH Client run on web browser

• Host: GitHub
• URL: https://github.com/klpod221/ssh-client
• Owner: klpod221
• Created: 2024-10-28T08:01:41.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T09:36:40.000Z (3 months ago)
• Last Synced: 2024-10-28T10:38:47.830Z (3 months ago)
• Topics: ejs, express, express-js, expressjs, node, node-js, nodejs, nodemon, socket-io, socketio, ssh, ssh-client, ssh2, xterm, xterm-js, xtermjs
• Language: CSS
• Homepage:
• Size: 1.87 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    
--// Web Base SSH Client //--

    

    

    



## About

This is a simple SSH client that allows you to connect to a remote server and execute commands. It is written in JavaScipt and uses the `ssh2` library to establish a connection.

## Demo Image

![Demo Image 1](./public/images/demo-1.png)

![Demo Image 2](./public/images/demo-2.png)

## Dependencies

- [Node.js](https://nodejs.org/en/) - I am currently using version 20.10.0

- [ssh2](https://www.npmjs.com/package/ssh2) - This is the library that allows us to connect to a remote server via SSH

- [xterm](https://www.npmjs.com/package/xterm) - This is the terminal emulator that we are using to display the output of the commands

- [xterm-addon-fit](https://www.npmjs.com/package/xterm-addon-fit) - This is an addon for xterm that allows the terminal to resize itself to fit the container

- [express](https://www.npmjs.com/package/express) - This is a web framework for Node.js that we are using to create a simple web server

- [socket.io](https://www.npmjs.com/package/socket.io) - This is a library that allows us to create a real-time, bidirectional communication between the client and the server

- [utf8](https://www.npmjs.com/package/utf8) - This is a library that allows us to encode and decode UTF-8 strings

- [nodemon](https://www.npmjs.com/package/nodemon) - This is a utility that will monitor for any changes in your source and automatically restart your server

- [ejs](https://www.npmjs.com/package/ejs) - This is a simple templating language that lets you generate HTML markup with plain JavaScript

## Development

To get started, clone the repository and install the dependencies:

```bash

git clone https://github.com/klpod221/ssh-client.git

cd ssh-client

npm install

```

To start the development server, run:

```bash

npm run dev

```

This will start the server on `http://localhost:3000`. You can now open your browser and navigate to this URL to see the SSH client in action.