https://github.com/henrywhitaker3/uptime-tracker

Monitor you internet uptime
https://github.com/henrywhitaker3/uptime-tracker

Last synced: about 1 month ago
JSON representation

Monitor you internet uptime

• Host: GitHub
• URL: https://github.com/henrywhitaker3/uptime-tracker
• Owner: henrywhitaker3
• License: gpl-3.0
• Created: 2020-07-22T00:55:36.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T07:12:47.000Z (over 3 years ago)
• Last Synced: 2024-05-28T14:12:07.985Z (7 months ago)
• Language: PHP
• Size: 35.4 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Uptime Tracker

[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/uptime-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/uptime-tracker) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/uptime-tracker?style=flat-square)](https://github.com/henrywhitaker3/uptime-tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/uptime-tracker?style=flat-square)](https://github.com/henrywhitaker3/uptime-tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/uptime-tracker?style=flat-square)](https://github.com/henrywhitaker3/uptime-tracker/commits) ![version](https://img.shields.io/badge/version-v1.0.0-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/uptime-tracker?style=flat-square)](https://github.com/henrywhitaker3/uptime-tracker/blob/master/LICENSE)

This program checks your internet connection every minute to generate a graph of your uptime. This can either be done by pinging an external IP address, or by curling a [healthchecks.io](https://healthchecks.io/) endpoint.

## Features

- Backup/restore data in JSON/CSV format

- Organizr integration

## Installation & Setup

### Using Docker

A docker image is available [here](https://hub.docker.com/r/henrywhitaker3/uptime-tracker), you can create a new conatiner by running:

```bash

docker create \

      --name=speedtest \

      -p 8766:80 \

      -v /path/to/data:/config \

      -e PUID=uid `#optional` \

      -e PGID=gid `#optional` \

      --restart unless-stopped \

      henrywhitaker3/uptime-tracker

```

### Using Docker Compose

```yml

    speedtest:

        container_name: speedtest

        image: henrywhitaker3/uptime-tracker

        ports:

            - 8766:80

        volumes:

            - /path/to/data:/config

        environment:

            - TZ=

            - PGID=

            - PUID=

            - BASE_PATH=/speedtest

        restart: unless-stopped

```

#### Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.

|     Parameter             |   Function    |

|     :----:                |   --- |

|     `-p 8765:80`          |   Exposes the webserver on port 8765  |

|     `-v /config`          |   All the config files reside here.   |

|     `-e PUID`             |   Optional. Supply a local user ID for volume permissions   |

|     `-e PGID`             |   Optional. Supply a local group ID for volume permissions  |