Metadata-Version: 2.1
Name: py3status-http-monitor
Version: 0.1.2
Summary: py3status http monitor show the status of http endpoints
Home-page: https://github.com/mcgillij/py3status-http-monitor
License: MIT
Keywords: http,monitor,status,i3,py3status
Author: mcgillij
Author-email: mcgillivray.jason@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Desktop Environment :: Window Managers
Classifier: Topic :: System :: Monitoring
Requires-Dist: py3status (>=3.34,<4.0)
Project-URL: Documentation, https://github.com/mcgillij/py3status-http-monitor
Project-URL: Repository, https://github.com/mcgillij/py3status-http-monitor
Description-Content-Type: text/markdown

# py3status-http-monitor
Python module for monitoring **http** services in your py3status bar.

## Screenshot
![Status Bar with py3status_http_monitor](https://raw.githubusercontent.com/mcgillij/py3status-http-monitor/main/images/status_bar.png)

## Prerequisites

This is an i3 / py3status module, so you'll need those first off.

## Installation

### From Git

``` bash
git clone https://github.com/mcgillij/py3status-http-monitor.git
mkdir -p ~/.i3/py3status && cd ~/.i3/py3status
ln -s <PATH_TO_CLONED_REPO>/src/py3status-http-monitor/http_monitor.py ./
```

### With Pip, Pipenv or Poetry

``` bash
pip install py3status-http-monitor
pipenv install py3status-http-monitor
poetry add py3status-http-monitor && poetry install
```

### Building Arch package w/PKGBUILD

``` bash
git clone https://aur.archlinux.org/py3status-http-monitor.git
cd py3status-http-monitor.git
makechrootpkg -c -r $HOME/$CHROOT
```

### Installing built Arch package

``` bash
sudo pacman -U --asdeps py3status-http-monitor-*-any.pkg.tar.zst
```

## Configuration

Next you will need to add the services you want to monitor, and optionally choose some appropriate emoji's.

**~/.config/i3/i3status.conf**

```bash
...
general {
        colors = true
        interval = 15
}

order += "http_monitor apache"
order += "http_monitor medusa"
order += "http_monitor pihole"
order += "http_monitor nextcloud"
order += "http_monitor plex"
order += "http_monitor virtualbox"
order += "http_monitor airsonic"
order += "clock"
order += "mail"
...

http_monitor  'nextcloud' {
   service_location = "http://yourserver:8181"
   service_name = '⛅'
}

http_monitor  'virtualbox' {
   service_location = "http://yourserver:81/vb/"
   service_name = '💻'
}

http_monitor  'plex' {
   service_location = "http://yourserver:32400/web/index.html#"
   service_name = '🎥'
}

http_monitor  'airsonic' {
   service_location = "http://yourserver:4040"
   service_name = '🍃'
}

http_monitor  'pihole' {
   service_location = "http://yourserver:80"
   service_name = '🕳️ '
}

http_monitor  'apache' {
   service_location = "http://yourserver:81"
   service_name = '🪶'
}

http_monitor  'medusa' {
   service_location = "http://yourserver:8081"
   service_name = '🐍'
}
```

## Configuration Options

You can pass in the following configuration options:

* service_location
* service_name
* timeout
* cache_timeout

## Restart i3

Once the package is installed and configured you just need to restart i3.

