Skip to content

Commit

Permalink
Refactor README.md (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
crypt0rr authored Dec 27, 2024
1 parent c9d3dc5 commit 87a63a7
Showing 1 changed file with 59 additions and 37 deletions.
96 changes: 59 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,67 @@
# Tailscale Docker Sidecar Configuration Examples

This repository provides examples of using [Tailscale](https://tailscale.com/) in a sidecar configuration within Docker, specifically for integrating Tailscale with services like [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome), [Plex Media Server](https://www.plex.tv/) and [Beszel](https://github.com/henrygd/beszel). By leveraging Tailscale's secure networking capabilities, these examples demonstrate how to seamlessly route traffic through Tailscale while maintaining service functionality and security.
This repository provides examples of using [Tailscale](https://tailscale.com/) in a sidecar configuration within Docker, specifically for integrating Tailscale with various services. By leveraging Tailscale's secure networking capabilities, these examples demonstrate how to seamlessly route traffic through Tailscale while maintaining service functionality and security.

The provided configurations showcase how to set up Tailscale alongside Docker services, with a focus on ensuring connectivity, security, and ease of deployment. The examples include configurations for Tailscale authentication, state management, and service routing.

The example below illustrates a basic setup where Tailscale is used to manage network traffic for AdGuard Home in a Docker environment, utilizing a sidecar approach to simplify networking and enhance security.

If you would like to add your own config, you can use the [service-template](templates/service-template/).

## Currently Available Example Configurations

- [AdGuard Home](services/adguardhome)
- [Bazarr](services/bazarr)
- [Beszel](services/beszel)
- [Changedetection.io](services/changedetection)
- [Cyberchef](services/cyberchef)
- [Dozzle](services/dozzle)
- [Excalidraw](services/excalidraw)
- [Gokapi](services/gokapi)
- [Homarr](services/homarr)
- [IT-Tools](services/it-tools)
- [Jellyfin](services/jellyfin)
- [LanguageTool](services/languagetool)
- [NextCloud](services/nextcloud)
- [Node-RED](services/nodered)
- [Pi-hole](services/pihole)
- [Pingvin Share](services/pingvin-share/)
- [Plex](services/plex)
- [Portainer](services/portainer)
- [qBittorrent](services/qbittorrent)
- [Radarr](services/radarr)
- [Resilio Sync](services/resilio-sync)
- [searXNG](services/searxng)
- [Sonarr](services/sonarr)
- [Stirling-PDF](services/stirlingpdf)
- [Tailscale Exit Node](services/tailscale-exit-node)
- [Tautulli](services/tautulli)
- [Technitium DNS](services/technitium)
- [Traefik Reverse Proxy](services/traefik)
- [Uptime Kuma](services/uptime-kuma)
- [Vaultwarden](services/vaultwarden)
If you would like to add your own config, you can use the [service-template](templates/service-template/) or simply open an [issue](https://github.com/2Tiny2Scale/tailscale-docker-sidecar-configs/issues).

## Available Configurations

### Networking and Security

| 🌐 Service | πŸ“ Description | πŸ”— Link |
| -------------------------- | ------------------------------------------------------------------------ | --------------------------------------- |
| πŸ›‘οΈ **AdGuard Home** | Network-wide software for blocking ads and tracking. | [Details](services/adguardhome) |
| 🧩 **Pi-hole** | A network-level ad blocker that acts as a DNS sinkhole. | [Details](services/pihole) |
| πŸ”’ **Technitium DNS** | An open-source DNS server that can be used for self-hosted DNS services. | [Details](services/technitium) |
| 🌐 **Traefik** | A modern reverse proxy and load balancer for microservices. | [Details](services/traefik) |
| πŸš€ **Tailscale Exit Node** | Configure a device to act as an exit node for your Tailscale network. | [Details](services/tailscale-exit-node) |

### Media and Entertainment

| πŸŽ₯ Service | πŸ“ Description | πŸ”— Link |
| ------------------ | ------------------------------------------------------------------------------------------ | ------------------------------- |
| 🎬 **Plex** | A media server that organizes video, music, and photos from personal media libraries. | [Details](services/plex) |
| πŸ“Ί **Jellyfin** | An open-source media system that puts you in control of managing and streaming your media. | [Details](services/jellyfin) |
| 🎞️ **Radarr** | A movie collection manager for Usenet and BitTorrent users. | [Details](services/radarr) |
| πŸ“‘ **Sonarr** | A PVR for Usenet and BitTorrent users to manage TV series. | [Details](services/sonarr) |
| πŸŽ₯ **Bazarr** | A companion tool to Radarr and Sonarr for managing subtitles. | [Details](services/bazarr) |
| πŸ“Š **Tautulli** | A monitoring and tracking tool for Plex Media Server. | [Details](services/tautulli) |
| πŸ“₯ **qBittorrent** | An open-source BitTorrent client. | [Details](services/qbittorrent) |

### Productivity and Collaboration

| πŸ’Ό Service | πŸ“ Description | πŸ”— Link |
| -------------------- | ------------------------------------------------------------------------------- | ---------------------------------- |
| ☁️ **NextCloud** | A suite of client-server software for creating and using file hosting services. | [Details](services/nextcloud) |
| πŸ“ **Excalidraw** | A virtual collaborative whiteboard tool. | [Details](services/excalidraw) |
| πŸ”— **Pingvin Share** | A self-hosted file sharing platform. | [Details](services/pingvin-share/) |
| πŸ—‚οΈ **Stirling-PDF** | A web application for managing and editing PDF files. | [Details](services/stirlingpdf) |
| 🧠 **LanguageTool** | An open-source proofreading software for multiple languages. | [Details](services/languagetool) |
| πŸ”„ **Resilio Sync** | A fast, reliable, and simple file sync and share solution. | [Details](services/resilio-sync) |
| πŸ—ƒοΈ **Vaultwarden** | An unofficial Bitwarden server implementation written in Rust. | [Details](services/vaultwarden) |

### Development Tools

| πŸ› οΈ Service | πŸ“ Description | πŸ”— Link |
| ------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
| πŸ”§ **Cyberchef** | A web app for encryption, encoding, compression, and data analysis. | [Details](services/cyberchef) |
| πŸ” **searXNG** | A free internet metasearch engine which aggregates results from various search services. | [Details](services/searxng) |
| πŸ–₯️ **Node-RED** | A flow-based development tool for visual programming. | [Details](services/nodered) |
| πŸ–₯️ **IT-Tools** | A collection of handy online tools for developers and sysadmins. | [Details](services/it-tools) |
| πŸ–₯️ **Dozzle** | A real-time log viewer for Docker containers. | [Details](services/dozzle) |
| πŸ–₯️ **Portainer** | A lightweight management UI which allows you to easily manage your Docker environments. | [Details](services/portainer) |
| πŸ–₯️ **Gokapi** | A lightweight self-hosted file sharing platform. | [Details](services/gokapi) |
| πŸ–₯️ **Homarr** | A sleek dashboard for all your Homelab services. | [Details](services/homarr) |
| πŸ–₯️ **Changedetection.io** | A tool for monitoring website changes. | [Details](services/changedetection) |

### Monitoring and Analytics

| πŸ“ˆ Service | πŸ“ Description | πŸ”— Link |
| ------------------ | ----------------------------------------------------------------------------------- | ------------------------------- |
| πŸ“Š **Uptime Kuma** | A self-hosted monitoring tool like "Uptime Robot". | [Details](services/uptime-kuma) |
| πŸ“‰ **Beszel** | A lightweight server monitoring hub with historical data, Docker stats, and alerts. | [Details](services/beszel) |

## Tailscale Funnel vs. Tailscale Serve

Expand Down

0 comments on commit 87a63a7

Please sign in to comment.