Skip to content

Commit

Permalink
update readme (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
adelowo authored Jan 24, 2024
1 parent 9b0eb42 commit d0376e3
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 6 deletions.
6 changes: 0 additions & 6 deletions README.MD

This file was deleted.

32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Sdump

An opensource HTTP request bin built over SSH

Sdump is a HTTP request bin built over SSH. I usually have to google for some
3rd party server or download a binary to inspect certain requests.

![sdump TUI](assets/sdump.png)

## Why?

There is always a new flavor of an HTTP request bin i have to use every other
month. Or sometimes, people have to download Ngrok to get a request bin
functionality i.e people have to download or use external services to
get a request bin.

I spend an awful amount of time in the terminal and it makes sense i should
be able to spin up and use a request bin on my terminal. Hence this
project sdump

SSH can normally forward local and remote ports. This service implements an
SSH server that only handles forwarding and nothing else.
The service supports multiplexing connections over HTTP/HTTPS with WebSocket
support. Just assign a remote port as port 80 to proxy HTTP traffic and 443
to proxy HTTPS traffic. If you use any other remote port, the server will
listen to the port for TCP connections, but only if that port is available.

## How to use

```sh
ssh ssh.sdump.app
```
Binary file added assets/sdump.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d0376e3

Please sign in to comment.