diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 340e00d1..460aa1d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,8 @@ git submodule update --init --recursive ### Start Develop Environment + _Note_: in vscode, you can use Reopen in dev container to start the develop environment. + ``` # in e2e folder, run: SSHPIPERD_DEBUG=1 docker-compose up --force-recreate --build -d diff --git a/README.md b/README.md index 2b48b96b..eee92d83 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ docker run -d -e USER_NAME=user -e USER_PASSWORD=pass -e PASSWORD_ACCESS=true -p ### start `sshpiperd` with `fixed` plugin targeting the dummy sshd server ``` -sudo ./out/sshpiperd ./out/fixed --target 127.0.0.1:5522 +./out/sshpiperd -i /tmp/sshpiperkey --server-key-generate-mode notexist --log-level=trace ./out/fixed --target 127.0.0.1:5522 ``` ### test ssh connection (password: `pass`) @@ -72,7 +72,7 @@ ssh 127.0.0.1 -l user -p 2222 Here illustrates the example of `addional challenge` before the `fixed` plugin. ``` -sudo ./out/sshpiperd --log-level=trace ./out/simplemath -- ./out/fixed --target 127.0.0.1:5522 +./out/sshpiperd -i /tmp/sshpiperkey --server-key-generate-mode notexist --log-level=trace ./out/simplemath -- ./out/fixed --target 127.0.0.1:5522 ``` ## Plugins @@ -150,7 +150,11 @@ How this work | | | | | | | | +------------------------+ +----------------+ -``` +``` + +## Ports to other platforms + + * [sshpiper on OpenWrt](https://github.com/ihidchaos/sshpiper-openwrt) by [@ihidchaos](https://github.com/ihidchaos) ## Migrating from `v0`