Update README.md

This commit is contained in:
james ryan 2024-06-02 11:59:11 -04:00
parent fd03957bb3
commit 6810a9079f

View File

@ -1,3 +1,7 @@
# ssh-client-orchestrate # ssh-client-orchestrate
simple tool which opens a persisent ssh tunnel on the client-side to a specified target orchestrator, forwarding the client's ssh port. mainly for accessing machines which do not have forwarded ports simple tool which opens a persisent ssh tunnel on the client-side to a specified target orchestrator, forwarding the client's ssh port. mainly for accessing machines which do not have forwarded ports
General idea: theres a main orchestrate server you initialize on a given host, which *does* have its ssh port forwarded to the internet. Then, you provide clients with a server to register with by giving a hostname and a port to forward to the machine.
This will fail if the client does not have a key-pair with the server.
Then it handshakes with the server and asks the server software to make an entry in `/etc/hosts` for it. the server then keeps track of the newly-registered client and periodically connects to check if its alive.