github.com/tiredofit/docker-tinc

About

This will build a Docker Image for tinc - A VPN service.

• Latest Release automatically downloaded and compiled (1.1 test series)
• Automatically downloads peer configuration files from git server based on network name.
• Configurable Options for resyncing information from git server
• Configurable Options to enable various types of compression or enable debugging for troubleshooting.
• Logrotate Installed and will rotate logs daily and hold for 7 days.

Do NOT use a public git server to host your repository, as it will reveal personal details of your network! You have been warned

Maintainer

• Dave Conroy

Table of Contents

• About
• Maintainer
• Table of Contents
• Prerequisites and Assumptions
• Installation
  • Build from Source
  • Prebuilt Images
    • Multi Architecture
• Configuration
  • Quick Start
  • Persistent Storage
  • Environment Variables
    • Base Images used
  • Networking
• Maintenance
  • Shell Access
• Support
  • Usage
  • Bugfixes
  • Feature Requests
  • Updates
• License
• References

Prerequisites and Assumptions

• This image relies on a private Git Repository to store configuration data. Create a private repo and user account in git before proceeding.

Installation

Build from Source

Clone this repository and build the image with docker build <arguments> (imagename) .

Prebuilt Images

Builds of the image are available on Docker Hub

docker pull docker.io/tiredofit/docker-tinc:(imagetag)
Builds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-tinc/pkgs/container/docker-tinc)

```bash
docker pull ghcr.io/tiredofit/docker-tinc:(imagetag)

The following image tags are available along with their tagged release based on what's written in the Changelog:

Multi Architecture

Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)

Configuration

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for development or production use.

• Set various environment variables to understand the capabilities of this image.

• Map persistent storage for access to configuration and data files for backup.

• Alter Firewall Configuration to allow access to network ports

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Environment Variables

Base Images used

This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate, nano.

Be sure to view the following repositories to understand all the customizable options:

Networking

The following ports are exposed.

NOTE: You must also allow capabilities for NET_ADMIN to docker to be able to have access to the IP Stack. Also, you must create /dev/tun as a device. If you want to make the Docker Host be able to be accessible you also must add network:host as an option otherwise only the containers will be accessible. See the working compose.yml example as shown above.

Maintenance

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is) bash

Support

These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.

Usage

• The Discussions board is a great place for working with the community on tips and tricks of using this image.
• Sponsor me for personalized support

Bugfixes

• Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.

Feature Requests

• Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
• Sponsor me regarding development of features.

Updates

• Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
• Sponsor me for up to date releases.

License

MIT. See LICENSE for more details.

References

• https://www.tinc-vpn.org