doc: update docs

master
Evan Chen 2021-11-06 12:09:54 +08:00
parent 8fcdbcb9fb
commit 665ee33866
3 changed files with 46 additions and 1 deletions

View File

@ -5,7 +5,7 @@ steps:
image: golang:1.17.2 image: golang:1.17.2
commands: commands:
- git tag $DRONE_TAG - git tag $DRONE_TAG
- bash build.sh - bash release.sh
- echo -n "latest,${DRONE_TAG#v}" > .tags - echo -n "latest,${DRONE_TAG#v}" > .tags
- name: gitea_release - name: gitea_release
image: plugins/gitea-release image: plugins/gitea-release

45
README.md Normal file
View File

@ -0,0 +1,45 @@
# Breacher
common ways to breach network. Including proxy, port forward, ssh tunnel, and backconnect in a single executable
## Install
```
sudo rm -f /usr/local/bin/breacher
sudo sh -c "curl -fsSL RELEASE_URL | tar -C /usr/local/bin/ -xz"
```
## Usage
```shell
Usage:
breacher [command]
Available Commands:
forward port forwarding for UDP->UDP / TCP->TCP
help Help about any command
proxy reverse proxy to url
tunnel ssh tunneling to access remote services
version Print the version number of breacher
Flags:
-h, --help help for breacher
-s, --silent silent log output
-v, --version version for breacher
Use "breacher [command] --help" for more information about a command.
```
## Systemd
```conf
[Unit]
Description=Breacher
[Service]
ExecStart=/usr/local/bin/breacher tunnel :8080 :80 user@example.com -i ~/.ssh/id_rsa
Restart=always
[Install]
WantedBy=multi-user.target
```

0
build.sh → release.sh Normal file → Executable file
View File