samply/bridgehead
1
0
Fork 0
mirror of https://github.com/samply/bridgehead.git synced 2025-06-17 01:20:14 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1513fe1c6cb4fc562b7d260a5d1556a3f2f8dc50
bridgehead/modules/ssh-tunnel.md
Jan 2ddd535794 feat: ssh tunnel (#292) 
* Added ccp module for a ssh tunnel

Usage details under https://github.com/samply/ssh-tunnel

* chore: update ssh-tunnel image to harbor

* feat: ssh tunnel support diffrent port

* chore: fix indentation

* chore: move to top level modules

* docs: add ssh-tunnel docs

---------

Co-authored-by: Tobias Kussel <tobias.kussel@dkfz-heidelberg.de>
2025-04-14 10:45:15 +02:00

1.1 KiB
Raw Blame History

SSH Tunnel Module

This module enables SSH tunneling capabilities for the Bridgehead installation. The primary use case for this is to connect bridgehead components that are hosted externally due to security concerns. To connect the new components to the locally running bridgehead infra one is supposed to write a docker-compose.override.yml changing the urls to point to the corresponding forwarded port of the ssh-tunnel container.

Configuration Variables

  • ENABLE_SSH_TUNNEL: Required to enable the module
  • SSH_TUNNEL_USERNAME: Username for SSH connection
  • SSH_TUNNEL_HOST: Target host for SSH tunnel
  • SSH_TUNNEL_PORT: SSH port (defaults to 22)

Configuration Files

The module requires the following files to be present:

  • /etc/bridgehead/ssh-tunnel.conf: SSH tunnel configuration file. Detailed information can be found here.
  • /etc/bridgehead/pki/ssh-tunnel.priv.pem: The SSH private key used to connect to the SSH_TUNNEL_HOST. Passphrases for the key are not supported!