From 665ee33866102a544647eb25d87ccadd297ceb1a Mon Sep 17 00:00:00 2001 From: Evan Chen Date: Sat, 6 Nov 2021 12:09:54 +0800 Subject: [PATCH] doc: update docs --- .drone.yml | 2 +- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++ build.sh => release.sh | 0 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 README.md rename build.sh => release.sh (100%) mode change 100644 => 100755 diff --git a/.drone.yml b/.drone.yml index d5526fd..e699a62 100644 --- a/.drone.yml +++ b/.drone.yml @@ -5,7 +5,7 @@ steps: image: golang:1.17.2 commands: - git tag $DRONE_TAG - - bash build.sh + - bash release.sh - echo -n "latest,${DRONE_TAG#v}" > .tags - name: gitea_release image: plugins/gitea-release diff --git a/README.md b/README.md new file mode 100644 index 0000000..7909e1f --- /dev/null +++ b/README.md @@ -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 +``` \ No newline at end of file diff --git a/build.sh b/release.sh old mode 100644 new mode 100755 similarity index 100% rename from build.sh rename to release.sh