OC-Minitel/vTunnel
Izaya 48cf9ffee1 made vtunnel clean up after itself better, hopefully 2018-04-15 23:19:48 +10:00
..
OpenOS/etc/rc.d made vtunnel clean up after itself better, hopefully 2018-04-15 23:19:48 +10:00
README.md updated the readme to relfect the rc-ness of vtunnel now 2018-04-15 23:18:10 +10:00
bridge.lua Added some more connection handling to the bridge 2018-04-15 22:21:12 +10:00
interminitel.lua moved vtunnel to the right place 2018-04-05 23:51:11 +10:00
vtunnel-protocol.md bridge improvements, mostly configuration 2018-04-06 16:51:45 +10:00

README.md

vTunnel - TCP-based Linked Card Emulator

vTunnel can be used to add bridging over the internet to any existing OpenOS software that uses linked cards.

Despite originally being written for Minitel, vTunnel implements a fully-functional linked card emulator and a server that will run under most unix-likes (OpenBSD is currently somewhat flaky, Linux is recommended).

The protocol is documented here

Setup

Server

Requirements

  • Some form of unix-like
  • Lua 5.2 or 5.3
  • Luasocket

Running the server

At present, all you need to do is run bridge.lua, for example:

lua53 bridge.lua [port] [timeout]

Client

OPPM

oppm install vtunnel

Manual

  1. Install vtunnel.lua to /etc/rc.d
  2. Install interminitel.lua to /usr/lib

Starting

vTunnel is invoked as follows:

rc vtunnel start <server address> <server port>

This will create a virtual linked card component connected to server_address:server_port

Minitel configuration

  1. Disable minitel with rc - rc minitel disable
  2. Enable vtunnel with rc - rc vtunnel enable
  3. Add the following to your ~/.shrc:
rc minitel start > /dev/null

This will ensure that Minitel sees the virtual tunnel component created by vTunnel and routes packets via it.