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
  • Search

© Copyright 2024-2026, Yusuke Watanabe.

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