https://github.com/dev6699/rterm

A web-based remote control application that allows users to control terminal remotely
https://github.com/dev6699/rterm

gotty remote-control terminal webterminal xtermjs

Last synced: 3 months ago
JSON representation

A web-based remote control application that allows users to control terminal remotely

• Host: GitHub
• URL: https://github.com/dev6699/rterm
• Owner: dev6699
• License: mit
• Created: 2024-05-13T08:31:50.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-02-07T13:16:42.000Z (about 1 year ago)
• Last Synced: 2025-02-07T14:24:03.692Z (about 1 year ago)
• Topics: gotty, remote-control, terminal, webterminal, xtermjs
• Language: Go
• Homepage:
• Size: 4.48 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GoDoc](https://pkg.go.dev/badge/github.com/dev6699/rterm)](https://pkg.go.dev/github.com/dev6699/rterm)

[![Go Report Card](https://goreportcard.com/badge/github.com/dev6699/rterm)](https://goreportcard.com/report/github.com/dev6699/rterm)

[![License](https://img.shields.io/github/license/dev6699/rterm)](LICENSE)

# 
RTERM


RTERM is a web-based remote control application that allows you to control your terminal remotely.

Inspired by [GoTTY](https://github.com/yudai/gotty)



    



## Installation

1. Import as package to existing project.

    ```bash

    go get github.com/dev6699/rterm

    ```

    ```go

    import (

        "github.com/dev6699/rterm"

        "github.com/dev6699/rterm/command"

    )

    func main() {

        rterm.SetPrefix("/")

        mux := http.NewServeMux()

        rterm.Register(

            mux,

            rterm.Command{

                Name:        "bash",

                Description: "Bash (Unix shell)",

                Writable:    true,

                AuthCheck:   auth.NewBasic("123456"),

            },

        )

        addr := ":5000"

        server := &http.Server{

            Addr:    addr,

            Handler: mux,

        }

        server.ListenAndServe()

    }

    ```

    Please check [example](cmd/rterm/main.go) for more information.

    

    

2. Prebuilt binary.

    - Grab the latest binary from the [releases](https://github.com/dev6699/rterm/releases) page.

3. From sources:

    ```bash

    # Clone the Repository

    git clone https://github.com/dev6699/rterm.git

    cd rterm

    # Build

    make build

    ```

## Usage

1. Start the binary `./rterm`.

2. Open web browser and navigate to `http://:5000`.

3. Get control of your terminal!

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.