Skip to content

kiesel/wormhole-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wormhole

Build Status on TravisCI GitHub release license

Wormhole is a an application that allows to open files from a commandline within a VM in your favorite editor(s) / applications in the host system.

Prerequisites are that:

  • the part of the VM filesystem that is hosting the files in question is mounted in your host OS
  • you are logging in via SSH (though that limitation is only relevant for the client part.)

Installation

  1. Download the latest release from the GitHub Releases page.
  2. Extract .wormhole.yml from the release zip into your home directory.
  3. Run wormhole / wormhole.exe

To start wormhole with your shell, put this line into .bashrc / .zshrc:

(nohup $HOME/wormhole.exe -quiet 2>&1 &)

Client installation

You'll need a client, too. Given you're using bash / zsh or a compatible shell, you can use kiesel/wormhole.

Security

Wormhole opens a port on a designated interface for you; when binding to public network interfaces, you might expose yourself to serious security risks.

The recommended setup is therefore, to bind it to the loopback address 127.0.0.1 / ::1 and use SSH to make that port available to your client system (which would usually be a local VM). The configuration file .ssh/config would look like this:

Host vbox vb 127.0.0.1
  Hostname 127.0.0.1
  Port 2222

  RemoteForward 127.0.0.1:5115 127.0.0.1:5115