{"id":13437480,"url":"https://github.com/tiredofit/docker-tinc","last_synced_at":"2025-05-08T21:20:32.789Z","repository":{"id":56814816,"uuid":"101132830","full_name":"tiredofit/docker-tinc","owner":"tiredofit","description":"Docker Mesh VPN service with monitoring","archived":false,"fork":false,"pushed_at":"2024-12-08T01:08:46.000Z","size":57,"stargazers_count":53,"open_issues_count":2,"forks_count":16,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T18:21:17.003Z","etag":null,"topics":["alpine","docker","git","s6-overlay","tinc","zabbix-agent"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tiredofit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["tiredofit"]}},"created_at":"2017-08-23T03:19:22.000Z","updated_at":"2025-02-05T03:43:32.000Z","dependencies_parsed_at":"2023-02-16T11:01:29.745Z","dependency_job_id":"e3df4813-7ebf-497c-b330-26531eac5ed5","html_url":"https://github.com/tiredofit/docker-tinc","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-tinc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-tinc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-tinc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-tinc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiredofit","download_url":"https://codeload.github.com/tiredofit/docker-tinc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253150008,"owners_count":21861808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alpine","docker","git","s6-overlay","tinc","zabbix-agent"],"created_at":"2024-07-31T03:00:57.559Z","updated_at":"2025-05-08T21:20:32.747Z","avatar_url":"https://github.com/tiredofit.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/tiredofit","https://www.paypal.me/tiredofit"],"categories":["HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"# github.com/tiredofit/docker-tinc\n\n[![GitHub release](https://img.shields.io/github/v/tag/tiredofit/docker-tinc?style=flat-square)](https://github.com/tiredofit/docker-tinc/releases/latest)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/tiredofit/docker-tinc/main.yml?branch=main\u0026style=flat-square)](https://github.com/tiredofit/docker-tinc/actions)\n[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/tinc.svg?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/tiredofit/tinc/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/tinc.svg?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/tiredofit/tinc/)\n[![Become a sponsor](https://img.shields.io/badge/sponsor-tiredofit-181717.svg?logo=github\u0026style=flat-square)](https://github.com/sponsors/tiredofit)\n[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal\u0026style=flat-square)](https://www.paypal.me/tiredofit)\n* * *\n\n## About\n\nThis will build a Docker Image for [tinc](https://www.tinc.org/) - A VPN service.\n\n* Latest Release automatically downloaded and compiled (1.1 test series)\n* Automatically downloads peer configuration files from git server based on network name.\n* Configurable Options for resyncing information from git server\n* Configurable Options to enable various types of compression or enable debugging for troubleshooting.\n* Logrotate Installed and will rotate logs daily and hold for 7 days.\n\n**Do NOT use a public git server to host your repository, as it will reveal personal details of your network! You have been warned**\n\n## Maintainer\n\n- [Dave Conroy](https://github.com/tiredofit)\n\n## Table of Contents\n\n- [About](#about)\n- [Maintainer](#maintainer)\n- [Table of Contents](#table-of-contents)\n- [Prerequisites and Assumptions](#prerequisites-and-assumptions)\n- [Installation](#installation)\n  - [Build from Source](#build-from-source)\n  - [Prebuilt Images](#prebuilt-images)\n    - [Multi Architecture](#multi-architecture)\n- [Configuration](#configuration)\n  - [Quick Start](#quick-start)\n  - [Persistent Storage](#persistent-storage)\n  - [Environment Variables](#environment-variables)\n    - [Base Images used](#base-images-used)\n  - [Networking](#networking)\n- [Maintenance](#maintenance)\n  - [Shell Access](#shell-access)\n- [Support](#support)\n  - [Usage](#usage)\n  - [Bugfixes](#bugfixes)\n  - [Feature Requests](#feature-requests)\n  - [Updates](#updates)\n- [License](#license)\n- [References](#references)\n\n## Prerequisites and Assumptions\n\n* This image relies on a private Git Repository to store configuration data. Create a private repo and user account in git before proceeding.\n\n## Installation\n\n### Build from Source\nClone this repository and build the image with `docker build \u003carguments\u003e (imagename) .`\n\n### Prebuilt Images\nBuilds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/tinc)\n\n```bash\ndocker pull docker.io/tiredofit/docker-tinc:(imagetag)\nBuilds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-tinc/pkgs/container/docker-tinc)\n\n```bash\ndocker pull ghcr.io/tiredofit/docker-tinc:(imagetag)\n```\n\nThe following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):\n\n| Container OS | Tag       |\n| ------------ | --------- |\n| Alpine       | `:latest` |\n\n#### Multi Architecture\nImages are built primarily for `amd64` architecture, and may also include builds for `arm/v7`, `arm64` and others. These variants are all unsupported. Consider [sponsoring](https://github.com/sponsors/tiredofit) my work so that I can work with various hardware. To see if this image supports multiple architecures, type `docker manifest (image):(tag)`\n\n## Configuration\n\n### Quick Start\n\n* The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [compose.yml](examples/compose.yml) that can be modified for development or production use.\n\n* Set various [environment variables](#environment-variables) to understand the capabilities of this image.\n* Map [persistent storage](#data-volumes) for access to configuration and data files for backup.\n* Alter Firewall Configuration to allow access to [network ports](#networking)\n\n### Persistent Storage\n\nThe following directories are used for configuration and can be mapped for persistent storage.\n\n| Directory       | Description         |\n| --------------- | ------------------- |\n| `/etc/tinc/`    | Root tinc Directory |\n| `/var/log/tinc` | Log Files           |\n\n### Environment Variables\n\n#### Base Images used\n\nThis image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`, `nano`.\n\nBe sure to view the following repositories to understand all the customizable options:\n\n| Image                                                  | Description                            |\n| ------------------------------------------------------ | -------------------------------------- |\n| [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux |\n\n| Parameter              | Description                                                                                                          | Default         |\n| ---------------------- | -------------------------------------------------------------------------------------------------------------------- | --------------- |\n| `CIPHER`               | Encryption Cipher                                                                                                    | `aes-256-cbc`   |\n| `COMPRESSION`          | Level of LZO Compression (e.g. 9)                                                                                    | `0`             |\n| `CRON_PERIOD`          | Adjustable time to check GIT Server for any updates                                                                  | `30`            |\n| `DIGEST`               | Hashing Digest                                                                                                       | `sha256`        |\n| `ENABLE_GIT`           | Enable Git Repository Functionality `TRUE` or `FALSE`                                                                | `TRUE`          |\n| `ENABLE_CONFIG_RELOAD` | Enable reloading Tinc when configuration changes                                                                     | `TRUE`          |\n| `ENABLE_WATCHDOG`      | Reload Tinc when it can't get a response from a host                                                                 | `FALSE`         |\n| `GIT_PASS`             | Password for above user (e.g. `password`)                                                                            |                 |\n| `GIT_URL`              | GIT Repository URL (ie `https://github.com/username/repo.git`)                                                       |                 |\n| `GIT_USER`             | Username to Authenticate to git server (e.g. `username`)                                                             |                 |\n| `INTERFACE`            | Which Interface to use (relies on /dev/tun) (e.g. `tun0`)                                                            | `tun0`          |\n| `LISTEN_PORT`          | Listening Port                                                                                                       | `655`           |\n| `LOG_LEVEL`            | Adjustable Debug level as per tinc documentation (e.g 5)                                                             | `2`             |\n| `LOG_PATH`             | Log Path                                                                                                             | `/var/log/tinc` |\n| `MAC_LENGTH`           | MAC Length                                                                                                           | `16`            |\n| `NETWORK`              | The VPN name -  (e.g. `securenetwork`)                                                                               |                 |\n| `NODE`                 | The unique hostname of the machine joining the VPN (e.g. `hostname`)                                                 |                 |\n| `PEERS`                | Which server should be used to contact first to create the mesh VPN (e.g. `host1_hostname_com` `host2_hostname_com`) |                 |\n| `PRIVATE_IP`           | The private IP that is assigned to this machine on the VPN (e.g. `172.16.23.13`)                                     |                 |\n| `PUBLIC_IP`            | The public IP you wish to listen on (e.g. `137.233.212.121`)                                                         |                 |\n| `SETUP_TYPE`           | Utilize these above environment variables `AUTO` or `MANUAL`                                                         | `AUTO`          |\n| `WATCHDOG_HOST`        | IP Address or hostname of host to check connectivity                                                                 |                 |\n| `WATCHDOG_FREQUENCY`   | How many seconds to wait between checks on host                                                                      | `60`            |\n\n### Networking\n\nThe following ports are exposed.\n\n| Port  | Description |\n| ----- | ----------- |\n| `655` | Tinc        |\n\n\u003e **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.\n\n* * *\n## Maintenance\n\n### Shell Access\n\nFor debugging and maintenance purposes you may want access the containers shell.\n\n````bash\ndocker exec -it (whatever your container name is) bash\n````\n\n## Support\n\nThese 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.\n### Usage\n- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.\n- [Sponsor me](https://tiredofit.ca/sponsor) for personalized support\n\n### Bugfixes\n- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.\n\n### Feature Requests\n- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.\n- [Sponsor me](https://tiredofit.ca/sponsor) regarding development of features.\n\n### Updates\n- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.\n- [Sponsor me](https://tiredofit.ca/sponsor) for up to date releases.\n\n## License\nMIT. See [LICENSE](LICENSE) for more details.\n## References\n\n* https://www.tinc-vpn.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-tinc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiredofit%2Fdocker-tinc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-tinc/lists"}