Giter VIP home page Giter VIP logo

tunnel's Introduction

tunnel.sh

Shell script to handle cloudflared quick tunnels

Robust shell script to retrieve & manage the "cloudflared" binary, adding basic functionality to control the quick tunnel.
Upon usage, the shell script creates a tunnel.cfg to store and retrieve the current tunnel URL & Port.
The tunnel logs are being written to /var/log/cloudflared.log.

Setup

Retrieve the latest tunnel.sh and store it in /usr/local/bin/

sudo bash -c "wget https://raw.githubusercontent.com/run2go/tunnel/main/tunnel.sh -O /usr/local/bin/tunnel.sh"

Make tunnel.sh file executable

sudo chmod +x /usr/local/bin/tunnel.sh

Create "tunnel" alias

alias tunnel='sudo /usr/local/bin/tunnel.sh'

Usage

Command Description
tunnel Print the current tunnel or create a new one with port 80
tunnel <PORT> Create new tunnel with designated port
tunnel <ADDRESS>:<PORT> Create new tunnel with designated address & port
tunnel stop Stop a running tunnel

Dependencies

  • wget
  • grep
  • sudo
  • procps

Windows Version

Standalone PowerShell command to execute the ps1 script

powershell -ExecutionPolicy Bypass -File tunnel.ps1

For a proper setup, perform these steps:

Retrieve the tunnel.ps1 script

wget https://raw.githubusercontent.com/run2go/tunnel/main/tunnel.ps1 -O C:\tunnel\tunnel.ps1

Create a function to execute the tunnel.ps1 script that supports argument passthrough

function Quick-Tunnel {
    param (
        [Parameter(ValueFromRemainingArguments = $true)]
        [string[]]$Args
    )
    $scriptPath = "C:\tunnel\tunnel.ps1"
    $params = @("-ExecutionPolicy", "Bypass", "-File", $scriptPath)
    if ($Args) {
        $params += $Args
    }
    & powershell $params
}

Set up a PS "tunnel" alias

Set-Alias -Name tunnel -Value Quick-Tunnel

License

MIT

tunnel's People

Contributors

run2go avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.