Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/noreplyui5/web-terminal

Web-based terminal with password security that can connect to SSH server's
https://github.com/noreplyui5/web-terminal

Last synced: about 2 months ago
JSON representation

Web-based terminal with password security that can connect to SSH server's

Host: GitHub
URL: https://github.com/noreplyui5/web-terminal
Owner: NoReplyUI5
License: gpl-3.0
Created: 2024-05-31T14:53:00.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-06-01T15:48:53.000Z (7 months ago)
Last Synced: 2024-06-02T16:45:15.482Z (7 months ago)
Language: JavaScript
Size: 32.2 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Web Terminal

This is a simple web terminal application that allows users to interact with a server via a web browser.

## Repository Stats

![GitHub Repo Stars](https://img.shields.io/github/stars/noreplyui5/Web-Terminal?style=for-the-badge)
![GitHub Repo Forks](https://img.shields.io/github/forks/noreplyui5/Web-Terminal?style=for-the-badge)
![GitHub Issues](https://img.shields.io/github/issues/noreplyui5/Web-Terminal?style=for-the-badge)
![GitHub Pull Requests](https://img.shields.io/github/issues-pr/noreplyui5/Web-Terminal?style=for-the-badge)
![GitHub Pull Requests](https://img.shields.io/github/license/noreplyui5/Web-Terminal?style=for-the-badge)

## Discord Community

Join our Discord community for support and discussions: [Click Here](https://discord.gg/Pv8WgVQrwY) 🙂

## Features

- Terminal interface for executing commands on a remote server.
- WebSocket communication for real-time interaction.
- Basic authentication for login.

## Installation

1. Clone the repository:

```bash
git clone https://github.com/noreplyui5/Web-Terminal.git
```

2. Install dependencies:

```bash
cd Web-Terminal
npm install
```

3. Configure environment variables by creating a `.env` file (see `.env.example` for reference).

4. Start the server:

```bash
npm start
```

5. Access the web terminal in your browser at `http://localhost:9001`.

## Configuration

The following environment variables can be configured in the `.env` file:

- `WEB_USERNAME`: Username for basic authentication (default: admin)
- `WEB_PASSWORD`: Password for basic authentication (default: admin)
- `SSH_HOST`: Hostname or IP address of the SSH server (default: 127.0.0.1)
- `SSH_PORT`: Port number of the SSH server (default: 22)
- `SSH_USERNAME`: Username for SSH authentication (default: root)
- `SSH_PASSWORD`: Password for SSH authentication (default: password)

## Usage

1. Visit the login page (`/login`) and enter your credentials.
2. Once logged in, you can execute commands in the terminal interface.

## License

This project is licensed under the [GPL General Public License v3.0](LICENSE).