Skip to content
Tunnel snap
Branch: master
Clone or download
Latest commit 9ee425d Dec 31, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
scripts Update PERL5LIB to fix perl. Dec 31, 2018
snap Render a graph in the status command. Dec 30, 2018
.gitignore init, draft. Mar 30, 2018
LICENSE
README.md Update README Dec 30, 2018

README.md

Tunnel

Snap Status

This project contains the sources of the snap tunnel, it's used to bridge network segments together over the Internet.

This snap relies on the software project tinc that does the actual work to mesh network segments together. Tinc has several advanced features that is out of scope for this snap. If you disagree or like to have something added, please open an issue.

A little warning

This snap is based on a pre-release of Tinc 1.1. I'm using 1.1 because it contains several improvements, like for example the invite future. Do not use this in production. I'm using this my self successfully to bridge both servers and workstations together.

The tunnel may also be restarted when snapd updates this snap, or when you change any settings. This is expected behavior, if you can't handle rare short disconnects please do not use this snap.

Install

I use the build services at build.snapcraft.io to build this snap. Master of this repository is published to the edge channel. Try it with snap install --edge tunnel.

The get the latest stable version, type snap install tunnel.

Why tunnel and not just tinc?

There is a little setup you need to do like create a tinc.conf, tinc-up and down scripts and the exchange the host keys. Configure bridges and possible setup routing to get started.

Tinc 1.1 solves a lot of that for some use cases with the "tinc join" feature but I feel that there still is a few pieces missing so I made this snap.

If you need to customize the setup outside what this snap provides, I recommend that you take your time to install tinc yourself.

Usage

Do a snap install tunnel on all your systems. At least one need to have a public exposed port. Run tunnel to get started.

Let's assume that you have a server, with the hostname "server" and a laptop with the hostname "laptop".

Install and setup permissions

Install it on both systems:

server> sudo snap install tunnel
laptop> sudo snap install tunnel

You now need to setup the permissions, the easiest way is just to run this (feel free to run tunnel.setup and inspect the commands):

server> tunnel.setup | sudo bash
laptop> tunnel.setup | sudo bash

All done, if you need to change the port on the server, run tunnel config.

Connect two hosts with add

Run tunnel add on both the client and server. Follow the instructions.

You can’t perform that action at this time.