create_tunnel: Create SSH tunnel

In geocryology/PermafrostDB: PermafrostDB

Create SSH tunnel

Description

Create an SSH tunnel in the background

Usage

create_tunnel(
  ssh_user,
  ssh_host,
  ssh_keyfile,
  db_host,
  db_port,
  local_port = 5555,
  ssh_port = 22
)

Arguments

ssh_user	username with which to connect to remote host
ssh_host	address of remote host from which request will be made (e.g. ip address)
ssh_keyfile	(optional) path to privatekey file to log onto remote host (must be in OpenSSH *.pem format - see details for more information)
db_host	character, address to database host
db_port	int, final destination port for requests on target machine
local_port	int, port on localhost through which to access remote host
ssh_port	int, ssh connection port of remote host (usually 22)

Details

the SSH tunnel makes requests to the target from a remote host. A local port is used to redirect requests through the tunnel. Keyfiles must be in OpenSSH format. Google has ample information on how to convert from ppk to pem files,

Value

int process id

geocryology/PermafrostDB documentation built on April 17, 2025, 11:54 a.m.