README

# vyatta-tinc

Please note, this is no longer supported. I no longer use tinc on any of my vyos/edgemax routers. Mainly becuase performance was not great on edgemax, and updating the OS was annoying needing to re-install packages etc. These days I tend to use wireguard between vyos hosts, and IPSEC on edgemax (or run vyos beside it for tunneling).

## What is it?
Templates and Scripts for vyatta/[vyos](http://vyos.net/)/[edgeos/edgemax](http://www.ubnt.com/) to allow managing [tinc](www.tinc-vpn.org)-based VPN Tunnels.

This has only been tested on Ubiquiti EdgeRouter Lite, but should work on anything that is vyatta-based.

## How to install

Firstly, you will need to enable the regular debian repositories depending on if you use [vyos](http://vyos.net/wiki/FAQ#How_do_I_install_debian_packages.3F) or [edgeos/edgemax](https://help.ubnt.com/hc/en-us/articles/205202560-EdgeMAX-Add-other-Debian-packages-to-EdgeOS).

Then enable the vyatta-tinc repository:

```
configure
set system package repository vyatta-tinc components vyatta-tinc
set system package repository vyatta-tinc distribution all
set system package repository vyatta-tinc url http://packages.dataforce.org.uk/
commit
```
And install with:
```
apt-get install tinc vyatta-tinc
```

You can also keep the packages up to date using `apt-get install tinc vyatta-tinc` - it is not reccomended to use `apt-get upgrade` when the normal debian repos are configured.

If you do not want to use the apt repository, .deb files are avaiable on the [releases](https://github.com/ShaneMcC/vyatta-tinc/releases) page.

## How to build

At the moment building is only tested on ubuntu, but it should work on debian.

Firstly, install the build-packages:

```
sudo apt-get install build-essential devscripts debhelper autotools-dev autoconf fakeroot automake
```

and then build:
```
debuild -us -uc
```

This will produce a number of files in the `../` directory, the one you care about is called `vyatta-tinc_1.0.0_all.deb` or so. This can then be SCP-ed up to your vyatta device.

## Installation

The fully-built package will only provide the ability to set the configuration, there is still a soft-depends on `tinc` which needs to be installed manually for the configuration to actually do anything, so this will require that the debian repositories have been added to your device.

After `tinc` is installed, you can then install `vyatta-tinc` using `dpkg -i vyatta-tinc_1.0.0_all.deb`

## Usage

Pretty much every config setting should be supported, if I've missed something then let me know by raising an issue against this repo.

One thing to be aware of, any time the tinc config is changed, /etc/tinc will be deleted and rebuilt based on the vyatta config, and any manual changes you have made will be deleted.

## Problems
My own tinc config is pretty simple, and it works fine - but if you find something doesn't work as expected, or is missing (that is related to vyatta-tinc not tinc itself) then please take a look at the [issues page](https://github.com/ShaneMcC/vyatta-tinc/issues) to see if it's a known issue. If not, please raise one to let me know and I'll do what I can to get it resolved. The more information you can give to help reproduce the issue the better.

## Pull Requests
Pull requests are appreciated and welcome!

## Questions
I can be found idling on various different IRC Networks, but the best way to get in touch would be to message "Dataforce" on Quakenet, or drop me a mail (email address is in my [github profile](https://github.com/ShaneMcC))