Categorygithub.com/dev6699/rterm
modulepackage
0.5.0
Repository: https://github.com/dev6699/rterm.git
Documentation: pkg.go.dev

# README

GoDoc Go Report Card License

RTERM

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

Inspired by GoTTY

Installation

  1. Import as package to existing project.

    go get github.com/dev6699/rterm
    
    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 for more information.

  2. Prebuilt binary.

    • Grab the latest binary from the releases page.
  3. From sources:

    # 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://<remote_ip>:5000.
  3. Get control of your terminal!

License

This project is licensed under the MIT License - see the LICENSE file for details.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Register binds all command handlers to the http mux.
SetPrefix to override default url prefix.
SetWSUpgrader to override default websocket upgrader.

# Structs

No description provided by the author