History

Izaya 8bb51d5a74 documented the keepalive stuff		2018-04-06 16:56:54 +10:00
..
README.md	documented the keepalive stuff	2018-04-06 16:56:54 +10:00
bridge.lua	implemented keepalives	2018-04-06 16:55:54 +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
vtunnel.lua	implemented keepalives	2018-04-06 16:55:54 +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

Not yet functional, but when it is:

oppm install vtunnel

Manual

Install vtunnel.lua to /usr/bin

Starting

vTunnel is invoked as follows:

vtunnel <server address> <server port> [poll timer] [keepalive timer]

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

Minitel configuration

Disable minitel with rc - rc minitel disable
Add the following to your .shrc:

vtunnel <server address> <server port> [poll timer] [keepalive timer]
rc minitel start