ssh_tunnel/README.md

An ansible role to set up an ssh tunnel and port forwardings from the remote machine to local machines

# Required variables
... e.g. in `group_vars`
- `ssh_tunnel_pubkey`: The complete line to be used in `authorized_keys`, e.g. "ssh-ed25519 AAAA[...]aU root@mylocalmachine"
- `ssh_tunnel_privkey`: The content of the corresponding private key file, including the BEGIN and END tags. It is highly recommended to put this inside an encrypted ansible vault.
- `tunneled_ports`: A list of port forwardings. Example:
  ```
  tunneled_ports:
  - exposed_port: 80 # public port at the remote machine
    ephemeral_port: 10080 # internal port at remote machine's localhost address. The ssh tunnel will fetch traffic from there
    dest_host: my-internal-http-server.local.domain.tld # domain or IP address of the destination machine. Must be reachable form the local machine.
    dest_port: 80 # open port at the destination machine
    protocols: ["tcp"] # list of protocols for this forwarding. "tcp" and "udp" are supported.
  ```
Initial commit 2022-07-13 12:52:07 +02:00			`An ansible role to set up an ssh tunnel and port forwardings from the remote machine to local machines`

Removed unnecessary warning from README 2022-07-13 13:06:37 +02:00			`# Required variables`
Initial commit 2022-07-13 12:52:07 +02:00			... e.g. in `group_vars`
			- `ssh_tunnel_pubkey`: The complete line to be used in `authorized_keys`, e.g. "ssh-ed25519 AAAA[...]aU root@mylocalmachine"
			- `ssh_tunnel_privkey`: The content of the corresponding private key file, including the BEGIN and END tags. It is highly recommended to put this inside an encrypted ansible vault.
			- `tunneled_ports`: A list of port forwardings. Example:
			```
			`tunneled_ports:`
			`- exposed_port: 80 # public port at the remote machine`
			`ephemeral_port: 10080 # internal port at remote machine's localhost address. The ssh tunnel will fetch traffic from there`
			`dest_host: my-internal-http-server.local.domain.tld # domain or IP address of the destination machine. Must be reachable form the local machine.`
			`dest_port: 80 # open port at the destination machine`
			`protocols: ["tcp"] # list of protocols for this forwarding. "tcp" and "udp" are supported.`
			```