From b29df807fb3888413d23007c072a54d614d04a03 Mon Sep 17 00:00:00 2001 From: gigirassy Date: Fri, 19 Jun 2026 23:15:47 +0200 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2182920..73e39f1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # the-pit -funny little endlessh clone in rust \ No newline at end of file +funny little endlessh clone in rust + +named after the predacon birthplace: https://tfwiki.net/wiki/Pit_(BW) + + +## instructions + +### linux +requirements: docker +1. copy compose.yml to place you want, read it for important notes +2. change your ssh port to something other than 22. make sure to unblock the new port in your firewall. then ``pkill sshd`` to kill all old connections and reconnect with new port. +3. docker compose up -d +### other oses +requirements: rust, cargo +1. build and copy binary to path. +2. change your ssh port to something other than 22. make sure to unblock the new port in your firewall. then ``pkill sshd`` to kill all old connections and reconnect with new port. +3. set it up as a service. +4. start the service with TARPIT_BIND=0.0.0.0:22 as env. + +## license + +isc \ No newline at end of file