OC-Minitel/vTunnel/OpenOS/usr/man/vtunnel

# 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](vtunnel-protocol.md)

## Setup

### Server Requirements

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

### Client Installation

#### OPPM

```
oppm install vtunnel
```

#### Manual

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

### Client setup

#### Creating a connection
Many connections can be configured. To add one:

```
rc vtunnel addpeer <server address> <server port>
```

## Usage

### Running the server

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

```
lua53 bridge.lua [port] [timeout]
```

### Client

vTunnel is invoked as follows:

```
rc vtunnel start
```

vTunnel can also be configured to start automatically:

```
rc vtunnel enable
```

There are several other commands available under `rc vtunnel`:

 - settimer - allows you to configure how often vTunnel polls the TCP socket
 - listpeers - shows which peers are configured, and the associated tunnel card addresses
 - delpeer - deletes a peer from the configuration, as shown in listpeers

### Minitel configuration

1. Disable minitel with rc - `rc minitel disable`
2. Enable vtunnel with rc - `rc vtunnel enable`
3. Enable minitel with rc - `rc minitel enable`

This will ensure that Minitel starts later than vTunnel, allowing it to see the virtual tunnel component.