SciTeX SSH

Getting Started

  • Installation
    • From PyPI (Python Package Index)
    • Prerequisites
    • Development
  • Quickstart
    • Setup a Tunnel
    • Check Status
    • Remove a Tunnel
    • Python API (Application Programming Interface)

Architecture

  • How It Works
    • The Problem: NAT (Network Address Translation) Traversal
    • The Solution: Reverse SSH Tunnels
    • Persistence via systemd and autossh
      • The Service File
    • The Three Operations
    • Environment Variables
    • Prerequisites
    • Alternative: No-sudo Setup via ~/.bashrc
    • Alternative: Persistent Session (screen, tmux, nohup)
    • Alternative: Direct Shell Scripts

API Reference

  • scitex_ssh
    • PolicyError
    • SSHResult
      • SSHResult.returncode
      • SSHResult.stdout
      • SSHResult.stderr
      • SSHResult.success
      • SSHResult.__init__()
    • attach()
    • copy_from()
    • copy_to()
    • exec_remote()
    • setup()
    • remove()
    • status()
    • get_version()
SciTeX SSH
  • Index
  • Edit on GitHub

Index

_ | A | C | E | G | M | P | R | S

_

  • __init__() (scitex_ssh.SSHResult method)

A

  • attach() (in module scitex_ssh)

C

  • copy_from() (in module scitex_ssh)
  • copy_to() (in module scitex_ssh)

E

  • exec_remote() (in module scitex_ssh)

G

  • get_version() (in module scitex_ssh)

M

  • module
    • scitex_ssh

P

  • PolicyError

R

  • remove() (in module scitex_ssh)
  • returncode (scitex_ssh.SSHResult attribute)

S

  • scitex_ssh
    • module
  • setup() (in module scitex_ssh)
  • SSHResult (class in scitex_ssh)
  • status() (in module scitex_ssh)
  • stderr (scitex_ssh.SSHResult attribute)
  • stdout (scitex_ssh.SSHResult attribute)
  • success (scitex_ssh.SSHResult property)

© Copyright 2024-2026, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.