mirror of https://github.com/backnotprop/plannotator.git synced 2026-09-14 14:17:26 +08:00

Files

T

Dave Smith 3391d071a4 Add SSH remote support with fixed port (#5 )

* Add SSH remote session support with fixed port

- Auto-detect SSH sessions via SSH_TTY/SSH_CONNECTION env vars
- Use fixed port 19432 over SSH for predictable port forwarding
- Add PLANNOTATOR_PORT env var for custom port configuration
- Add retry loop (5 attempts) for port conflicts
- Print SSH config hint when running remotely
- Skip browser auto-open in SSH sessions

* integration test for ssh

---------

Co-authored-by: Michael Ramos <mdramos8@gmail.com>

2025-12-31 10:00:03 -08:00

1.9 KiB

Raw Permalink Blame History

Testing SSH Remote Support with Docker

This setup creates a Docker container with SSH server to test Plannotator's SSH remote session detection.

Build and Run

# From repo root, cd into this directory
cd tests/manual/ssh

# Build the Docker image
docker-compose build

# Start the SSH server
docker-compose up -d

# Check it's running
docker-compose ps

Test SSH Detection

Option 1: SSH into the container and run test script

# SSH into the container (password: testpass)
ssh -p 2222 root@localhost

# Once inside, run the test script
cd /app
chmod +x test-ssh.sh
./test-ssh.sh

You should see:

[SSH Remote Session Detected] message
Instructions for SSH port forwarding
Server running on port 19432

Option 2: Test via SSH with port forwarding

# In one terminal, SSH with port forwarding
ssh -p 2222 -L 19432:localhost:19432 root@localhost

# Inside the SSH session, run:
cd /app
echo '{"tool_input":{"plan":"# Test Plan\n\nTest content"}}' | bun run apps/hook/server/index.ts

# In another terminal on your local machine, open browser
open http://localhost:19432

Option 3: Test local (non-SSH) mode

# Execute directly in container without SSH
docker-compose exec plannotator-ssh bash -c 'cd /app && echo "{\"tool_input\":{\"plan\":\"# Test Plan\n\nTest content\"}}" | bun run apps/hook/server/index.ts'

You should see:

NO [SSH Remote Session Detected] message
Random port assignment (since SSH_TTY and SSH_CONNECTION are not set)

Verify SSH Environment Variables

# SSH into container
ssh -p 2222 root@localhost

# Check SSH env vars are set
echo "SSH_TTY: $SSH_TTY"
echo "SSH_CONNECTION: $SSH_CONNECTION"

Clean Up

docker-compose down

Environment Variable Override

To test custom port:

ssh -p 2222 root@localhost
cd /app
PLANNOTATOR_PORT=9999 ./test-ssh.sh

Server should use port 9999 instead of 19432.

1.9 KiB Raw Permalink Blame History