Skip to content

Commit

Permalink
docs: add installation tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
c3b2a7 committed Jun 23, 2024
1 parent 814af06 commit 86dbeed
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SSH Tunnel

[![GitHub](https://img.shields.io/github/license/c3b2a7/ssh-tunnel)](https://github.com/c3b2a7/ssh-tunnel/blob/master/LICENSE)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/c3b2a7/ssh-tunnel/build.yml)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/c3b2a7/ssh-tunnel)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/c3b2a7/ssh-tunnel)
[![GitHub](https://img.shields.io/github/license/c3b2a7/sshtunnel)](https://github.com/c3b2a7/sshtunnel/blob/master/LICENSE)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/c3b2a7/sshtunnel/build.yml)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/c3b2a7/sshtunnel)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/c3b2a7/sshtunnel)

> A tunneling tool based on ssh protocol can be used for port forwarding. No dependency and out of the box.
Expand All @@ -12,11 +12,36 @@
- support `local`,`remote`,`dynamic` ssh port forwarding
- support `ssh-key`,`password` authentication method

## Installation

### Using curl/sh:

```shell
curl https://raw.githubusercontent.com/c3b2a7/sshtunnel/master/scripts/get-sshtunnel.sh | sh
```

See the help output for more options:

```shell
curl https://raw.githubusercontent.com/c3b2a7/sshtunnel/master/scripts/get-sshtunnel.sh | sh -s -- -h
```

### From source:

```shell
go install github.com/c3b2a7/sshtunnel@latest
```

### Manual

You can also download and extract the latest release from
[https://github.com/c3b2a7/sshtunnel/releases](https://github.com/c3b2a7/sshtunnel/releases)

## Usage

```shell
./sshtunnel-macos-arm64
Usage of ./sshtunnel-macos-arm64:
./sshtunnel
Usage of ./sshtunnel:
-config string
config file
-v show version information
Expand Down

0 comments on commit 86dbeed

Please sign in to comment.