Giter VIP home page Giter VIP logo

kuma-tailscale's Introduction

Uptime Kuma with Tailscale Dockerfile (AMD64/ARM64/ARM(v7))

Note

This is a modified fork of SGprooo/Uptime-Kuma-Tailscale-Docker to include the ability to set a custom login server, using the environment variable TS_SERVER

Work in progress - Though the dockerfile builds and runs fine at its current state

This Dockerfile is your ticket to building a docker image for Uptime Kuma with Tailscale support; Uptime Kuma is a self-hosted monitoring tool, and Tailscale is a zero config VPN, making this combination a pretty useful one.

The Dockerfile provided always fetches the latest version of each image during the build, I'm still working on pinning a working version. (fallback for when the "latest" build fails)

Getting Started

1. Clone the Repository

Grab this repository by running:

git clone https://github.com/SGprooo/Uptime-Kuma-Tailscale-Docker.git

2. Build the Docker Image

Navigate to the directory with the Dockerfile and start the build:

docker build -t uptime-kuma-tailscale-docker .

3. Fire Up the Docker Container

Launch the Docker container with this command:

docker run -d --restart=always -p 3001:3001 --device /dev/net/tun:/dev/net/tun --cap-add=NET_ADMIN -v uptime-kuma:/app/data --name uptime-kuma -e TSKEY=YOUR_TAILSACLE_API_KEY -e TS_HOSTNAME=YOUR_HOSTNAME uptime-kuma-tailscale

Replace YOUR_TAILSACLE_API_KEY and YOUR_HOSTNAME with your Tailscale API key and desired hostname respectively. The hostname defaults to TailscaleUptimeKuma if not specified. You can generate a API key here.

Docker Container Configurations

Environment Variables

  • TSKEY: Your Tailscale API key.
  • TS_HOSTNAME: The hostname for your Tailscale node. Defaults to TailscaleUptimeKuma.

Volumes

  • /app/data: This is where Uptime Kuma stores its data.

Exposed Ports

  • Uptime Kuma's web interface is accessible at port 3001. If you need to map this port elsewhere, use -p 3002:3001 in your docker run command. (You can also access this web interface from other devices on the same Tailent)

Credit

This Dockerfile was revised from a dockerfile in discussion under this issue. As of the time of writing this, the build works fine with Tailscale 1.40.1 and Uptime Kuma 1.21.3. If you have any improvements, feel free to create a pull requests.

And heads up, I'm still figuring out how to integrate Tailscale ping with Uptime Kuma instead of using its default ICMP pings. I'll pull Uptime Kuma in the future.

Written with ❤️ to Tailscale

kuma-tailscale's People

Contributors

sandiyosdev avatar willscottuk avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.