https://github.com/dwisiswant0/ngocok
ngrok Collaborator Link — yet another Burp Collaborator alternative for free with ngrok.
https://github.com/dwisiswant0/ngocok
Last synced: 9 days ago
JSON representation
ngrok Collaborator Link — yet another Burp Collaborator alternative for free with ngrok.
- Host: GitHub
- URL: https://github.com/dwisiswant0/ngocok
- Owner: dwisiswant0
- License: mit
- Created: 2023-12-24T21:05:41.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T07:49:44.000Z (almost 2 years ago)
- Last Synced: 2025-03-02T05:11:19.625Z (8 months ago)
- Language: Go
- Size: 15.6 KB
- Stars: 117
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ngocok
ngrok Collaborator Link — yet another Burp Collaborator alternative for free with ngrok.
## Prerequisites
* **ngrok authtoken**: Authentication token from your ngrok account is required to establish a ngrok tunnel. See [Your Authtoken](https://dashboard.ngrok.com/get-started/your-authtoken).
> [!IMPORTANT]
> If `ngrok` is already configured on your machine with `ngrok config add-authtoken`, you can go ahead to the [installation](#installation) section.
> [!TIP]
> To find the location of the configuration file, execute `ngrok config check` or consult the [ngrok Agent Configuration File](https://ngrok.com/docs/agent/config/) documentation page.
That's it!
## Installation
> [!NOTE]
> Go version [**1.20+**](https://go.dev/doc/install) should be installed & configured.
```bash
$ go install github.com/dwisiswant0/ngocok@latest
```
### — or
Manually build the executable from the source:
```bash
$ git clone https://github.com/dwisiswant0/ngocok ngocok/
$ cd $_
$ go build . # or
$ go install .
```
## Usage
It's quite straightforward. Simply execute `ngocok`, and you're ready to capture the out-of-band requests!
Here are the supported options:
| **Flag** | **Description** | **Default** |
|------------------- |--------------------------------------------------- |------------- |
| `-e`/`--endpoint` | ngrok tunnel endpoint ("`http`" or "`tcp`") | "`http`" |
| `-t`/`--token` | ngrok authentication token | "" |
| `--unstrip` | Unstrip `X-Forwarded-{For,Host,Proto}` headers | `false` |
| `-o`/`--output` | Log incoming requests to a file instead of stdout | "" |
> [!CAUTION]
> Using a `-t`/`--token` flag will takes precedence over the `NGROK_AUTHTOKEN` environment variable, and using `NGROK_AUTHTOKEN` environment variable will takes precedence over the ngrok config file[[?](#prerequisites)].
### Examples
Start a tunnel with default endpoint (HTTP) and use the ngrok authentication token from the config file.
```bash
$ ngocok
```
Start a tunnel with a TCP endpoint.
```bash
$ ngocok --endpoint tcp
```
Start a tunnel with an HTTP endpoint and provide the ngrok authentication token using the `-t`/`--token` flag.
```bash
$ ngocok --token [authtoken]
```
Start a tunnel with an HTTP endpoint and use the ngrok authentication token from the `NGROK_AUTHTOKEN` environment variable.
```bash
$ NGROK_AUTHTOKEN="..." ngocok
```
Start a tunnel with an HTTP endpoint and log incoming requests to a file.
```bash
$ ngocok --output /path/to/requests.log
```
## Why is this name?
¯\_(ツ)_/¯
## Similar Projects
* [projectdiscovery/interactsh](https://github.com/projectdiscovery/interactsh): An OOB interaction gathering server and client library.
## License
**`ngocok`** is made with ♥ by [**@dwisiswant0**](https://github.com/dwisiswant0) under MIT license. See [LICENSE](/LICENSE).