monitorr / monitorr Goto Github PK

This is gonna be a big feature, but I think it's really needed.

one tile that will list server/system resources, don't wanna get to crazy with this, just the basics here. a quick list right now:

• CPU
• MEM
• UPtime
• PING RT

Updated: jonfinley 3/5
Feature: Integrated Settings Page

STATUS: Pushing to master

Current Branch: Develop

BUGS:

• Form validation to check for trailing slash DrRoach/FormValidation#1
• New Alpaca version breaks the default select option: gitana/alpaca#612
• Services Form Layout won’t render in two-column – gitana/alpaca#610
• Service Settings: Radio Buttons uncheck when switching order
• URL validation for rox puny code shit?! WTF https://en.wikipedia.org/wiki/Punycode

Progress:

• (Complete) Development
• (Complete) Functionality
• (Complete) Pushed to Alpha
• (Complete) Test: Windows
• (Complete) Test: Docker
• (Complete) Test: Linux
• (Complete) UI Android
• (Complete) UI iOS:
• (Complete) Merged to DEV
• (Pending) Merged with master
• (Pending) Release published

Individual setting pages:

1. Info:

• PHPInfo
• Update check/execute
• Github link / Docker Hub link
• Donate Link
• CSS

2. User Preferences:

• Site Title

• Site URL

• Language??

• Time Standard

• Time Zone (!issue)

• Update Branch

• UN & PW

• CSS

3. Monitorr Settings:

• Alert Banner enable/disable
• Refresh sysinfo
• Refresh Time
• Ping Host
• Ping Port
• CPU OK
• CPU Warn
• RamOK
• RamWarn
• HD OK
• HD Warn
• CSS

4. Services:

• Service Title
• Service Image
• Check Type
• Check URL – DONE
• Link URL – DONE
• Offline Link URL - LATER
• Authentication - LATER
• CSS

• Add link to wiki
• Remove Config and replace with wiki?
• Add small blurb of HOW Monitorr works
• Add link to Logarr
• Credits (Leram, Causefx)

Issue: HTTPs resources don't work / always reports OFFLINE.

Status: Investigating.

Server Specs:
Windowns 10 - Version 1703 (OS Build 15063.674)
nginx version 1.13.6
PHP version 7.1.11

PHP block in nginx.conf:

  ## Enable PHP
    location ~ \.php$ {
  	try_files $uri =404;
  	fastcgi_param HTTPS on;
        fastcgi_pass 127.0.0.1:9000;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
  	fastcgi_param REMOTE_ADDR $http_x_real_ip;
        include fastcgi_params;
  }

The colors for Online/Offline are a little too bright. Need to tone these down a bit.

Color picker or box in settings page.
Users enter #123456 and it will update the color of the online/offline icons

FEAT: Move sys resource above service badges.

Just like the title states. Would like to have an option to choose between 12/24hr clock in the assets/config.php file and option to remove seconds and be able to use am/pm

BUG: Time refresh variable (RFTIME) in config.php is not functional.

STATUS:

• (OK) Development: Complete
• (OK) Functionality
• (In-progress) Test: Windows
• (Pending) Test: Linux
• (OK) UI Android: N/A
• (OK) UI iOS: N/A
• (Pending) Pushed to DEV
• (Pending) Merged with master
• (Pending) Release published

Solution:

Will be added when settings version is released.

Quick fix: Change the following block in index.php:

    <script type= "text/javascript">
        $(document).ready(function() {
            function update() {
            $.ajax({
            type: 'POST',
            url: 'assets/php/timestamp.php',
            timeout: 5000,
            success: function(data) {
                $("#timer").html(data); 
                window.setTimeout(update, 2000);
                }
            });
            }
            update();
        });
    </script>

Change to:

window.setTimeout(update, <?php echo $config['rftime']; ?>);

Not sure what I screwed up, but I can't figure it out. It's either in \js\clock.js or \php\loop.php

1. Spacing of tiles - Need to somehow define relative spacing to browser window (like the old .HTML version was) See below. IF you have a lot of tiles, it looks fine, but if you only have a few and are viewing the page on wide zoom config, it looks bad...too much padding

2. Need offline link function (I really think this is a good feature. I know not everyone uses uptime robot, but if the service is offline, need to send the request to some type of user-defined offline page, in fact, we can make a very simple one as a default / place holder that will live in the repo base DIR, and the user can change it if they want - OR we can simply redirect them back to the base URL)

3. Need to add link to the bottom of index.php which shows GIT version, like this:
   

4. Need to possibly rethink the auto-generation of the images based on the user-defined link in conig.php. SOME users may not use the most common names. For example, I don't use "OMBI" (because no one knows what the F that stands for) - so IF I want the service title to be "plex request" but show the OMBI icon, you'd have to define that.

5. let's go ahead and merge PHP with Dev, and push dev to master.

Thanks it for now, great work @jonfinley @wjbeckett !!! SICK!

Need to change the way we supply the config file so that updates do not overwrite a users config.

• Change the config.php to config.php.sample
• Update README to reflect the new config setup (copy config.in.sample to config.ini)

My gogs server is always showing offline

Would be great to add these right next to CPU/RAM/UPTIME, above or below them.

One button can be Contact to allow users to contact us directly. Another one for About that can redirect users to another page to get info about server, how to request access etc etc.

The OFFLINE image already denotes that's it's down, but it will still be a hyperlink to the DOWN link, so we just need to point that link somewhere, either BACK to the index.php, or I would say let's create a quick offline page that the user can change via the settings.php page

Issue: Service tiles are not populating in rows and columns properly

Suggestion:

Default: Need to set default display of 6 tiles wide
Interim: Possible use tables?
End result: Be able to define ROWs for each service via the /assets/config file.

Restyle verticle scroll bars

Git info in footer will not display on windows host.

If I use bg gradient in the body section of main.css, I get a page with background tiling vertically into 3 rows. A single background color works properly with no tiling.

And no matter what radius I use for btnonline and btnoffline, I can't change the shape of the buttons.

to do list (on-going):

• Fix clock/timer .jS so analog and digital are server local DTG
  -- Uncaught ReferenceError: $config is not defined
  at clock.js:52

System stats:
PHP 5.6.12
Win 10 v. 1703 (OS Build 15063.674)
CPU: Ryzen 1700
32 GB Ram

CPU seems correct, ping seems correct, uptime is stuck at 0, RAM is over 100%

BLUF: Apps that are known to NOT work with Monitor (PHP-CURL)r:

• DD-WRT
• NZBGet
• Mattermost

Background: Monitorr uses CURL to receive HTTP status codes from services in order to determine UP/DOWN status. This is a bit more advanced than a simple ping. CURL actually checks to see if the webapp/site is responding whereas PING simply checks to see if there is ANY response on that port.

ISSUE: There are some services that will NOT respond to CURL requests. We assume this is for security as to combat DDOS attacks or PING flood. Unfortunately, there's no way around this right now other than to ask the software developer to build CURL responses into their software/UI.

You can test this by running the following command in a terminal ON THE SERVER that is hosting Monitorr. You will want to use the same exact address you use in your Monitorr/assets/config.php file.

curl -I -L http://192.168.1.1

You'll see the response below that this particular device (in this case DDWRT) rejects the curl request. So even tho the user can access that exact address from a browser, Monitorr would report this service as DOWN.

Response:

C:\WINDOWS\system32>curl -I -L http://192.168.1.1
curl: (52) Empty reply from server

These are examples of successful CURL responses:
(The below example is to PLEX, even tho the response is "unauth" the website IS responding, therefore Monitorr would report it as UP.)

C:\WINDOWS\system32>curl -I -L localhost:32400
HTTP/1.1 401 Unauthorized
Content-Length: 193
Content-Type: text/html
X-Plex-Protocol: 1.0
Cache-Control: no-cache
Date: Thu, 04 Jan 2018 18:55:04 GMT

And below are normal successful responses:

C:\WINDOWS\system32>curl -I -L localhost:80
HTTP/1.1 301 Moved Permanently
Content-Length: 144
Content-Type: text/html; charset=UTF-8
Location: http://localhost/home
Server: Microsoft-IIS/10.0
 Access-Control-Allow-Origin: Access-Control-Allow-Origin: http://www.yourdomain.com
Date: Thu, 04 Jan 2018 18:55:15 GMT

HTTP/1.1 301 Moved Permanently
Content-Length: 145
Content-Type: text/html; charset=UTF-8
Location: http://localhost/home/
Server: Microsoft-IIS/10.0
 Access-Control-Allow-Origin: Access-Control-Allow-Origin: http://www.yourdomain.com
Date: Thu, 04 Jan 2018 18:55:15 GMT

HTTP/1.1 200 OK
Content-Length: 8118
Content-Type: text/html
Last-Modified: Wed, 27 Dec 2017 02:26:49 GMT
Accept-Ranges: bytes
ETag: "aea44b26ba7ed31:0"
Server: Microsoft-IIS/10.0
 Access-Control-Allow-Origin: Access-Control-Allow-Origin: http://www.yourdomain.com
Date: Thu, 04 Jan 2018 18:55:15 GMT

Suggestion: There are a few workarounds:

1. For a service that reports as DOWN (non-reverse proxied service) despite it actually being UP - set the monitored link in config.php to a reverse proxy link - this will allow you to have a working link on your Monitorr UI given the service is actually UP.

2. If reverse proxy is NOT an option - you can edit the Monitorr CSS HTML code so that you don't see the ugly "RED" on your Monitorr UI and to always show an UP status.

Way ahead:

We are looking into a few options such as backup simple PING, LINX, or custom response codes. If you have any ideas. Hit us up on Discord!

NOTE: /assets/php/check.php ADD the following line to NOT allow Monitorr to check beyond your reverse proxy:

 curl_setopt($handle, CURLOPT_FOLLOWLOCATION, FALSE);

FEAT: Add Color code for Auth code return

Add yellow status for webserver code (x?) returns?

Layout issues with Bootstrap are making me want to rewrite it from scratch.
Putting this in for v1 as it'll require a considerable amount of work as the functions file needs to be rewritten/condensed too.

Clock tile "blinks" due to refresh of services poll. I think we can roll the refresh of the time and the services into one action. I didn't look into that yet.

Your environment:

• Operating system: Docker Container (Official)

• Monitorr Branch: Master

Describe your issue:

The goal would be to allow the user to REMOVE the hyperlink behind certain icons or even all icons. Specifically, I display this at the top of a screen in Organizr. When a user logs in, I show them Plex, Requests, NZBget, Sonarr, Radarr statuses. The goal is to show that all systems are up and available or if not, that there is an issue obviously. I'd like to remove the links though for NZBget/Radarr/Sonarr - because they won't have access and I don't want them to click on it and think something is broken.

Spacing of tiles - Need to somehow define relative spacing to browser window (like the old .HTML version was) See below. IF you have a lot of tiles, it looks fine, but if you only have a few and are viewing the page on wide zoom config, it looks bad...too much padding

• Limitations:
  a. Internet Explorer....ooofff
  b. iOS Safari?
  c. Services don't respond to CURL (NZBGET, DDWRT)
  d. Mobile Display - Bootstrap in development

• PHP issues: Users needs to check /monitorr/assets/php/phphpinfo

• False up/down status
  a. Webserver Authentication
  b. Base URLs: Depending on servcie/app, user must config base URL after PORT (Example: (PlexPY): 127.0.0.1:32500 will report as DOWN, 127.0.0.1:32500/PLEXPY will report as UP).
  c. testing return codes with curl:

curl -I -L http://192.168.1.1

To check a resource which required authentication, the following can be used:

curl -I -L -u username:password http://yoursite.com

https://curl.haxx.se/libcurl/c/libcurl-errors.html

• Org / auth breaks monitorr
  a. application/API work-around?

• Browser cache/CSS issues after update.

• Customizations:
  a. Adding custom images
  b. Turn off scrolling on min site

The container is off-centered

BUG: horizontal scroll bar appears on bottom of browser window

Your environment:

• Operating system: test

• Webserver: NGIX v. 3.8 test

• PHP Version: 7.2.1 x64 NTS

• Monitorr Branch: master

Describe your issue:

Hi. this is a test issue to test the issue template

Issue: When integrating as an iframe with wrappers such as Organizr, the headers/footers of Monitorr will not allow for optimal display.

Suggestion: Create a "minimal" version with headers/footers removed.

Status: In development

Running this using unraid under a nginx docker container and memory usage shows 98.49%. I have a total of 128gb ram and I know for a fact that amount is not accurate.

Issue: Users will want to config their own refresh times for assets (time, service, system info)

Suggestion: Move all refresh times for all assets to config.php

"The monitor lizards are large lizards in the genus Varanus. They are native to Africa, Asia and Oceania, but are now found also in the Americas as an invasive species"

Thinking a lizard with big buggy eyes. You know, cuz he's watching your shit.

Kinda like this:

Add system info to Monitorr UI.
Needs to represent:

• CPU
• RAM
• Network
• HDD
  Must be OS agnostic as well.

The analogue clock shows browser time, NOT server time. The lower digital clock is fine.

The analogue clock and digital clock use two assets to get time.

Analogue uses clock.php while
Digital clock uses timestamp.php

Not sure how to pass the config values from config.php (which defines the TIMEZONE) into the clock.js.

ref:

https://stackoverflow.com/questions/22926412/passing-php-variable-to-external-javascript-file

The README is a little confusing at the moment so might be good to reorganize it and make the instructions a little clearer for new users.

Tasks:

• Editing Config file instructions
• Adding custom images instructions
• Display major known bugs
• Add main features
• Donation link

Feature: PING Fallback

STATUS: In-development

Current Branch: none

Progress:

• (In-progress) Development
• (Pending) Functionality
• (Pending) Pushed to TEST
• (Pending) Test: Windows
• (Pending) Test: Linux
• (Pending) UI Android: N/A
• (Pending) UI iOS: N/A
• (Pending) Merged to DEV
• (Pending) Merged with master
• (Pending) Release published

Functionality changes:
1: All services MUST have PORT identified.
2: Sub DIR work so localhost:80/applicaiton is good.

Issues:

• Fallback Method:
  a. The alternate fallback method currently being tested is "file_get_contents" which supports HTTP/S, PORT, and PATH URLs. Does NOT support AUTH.
  b. need to further develop this to ultimately use fsockopen. However, will need to build a function to first strip away the protocol and any subpaths after :PORT. This can be done with parse_url() which can then pass a "sterile" URL to fsockopen for fallback "ping" check.
  c. Can fsockopen use identified PORT?

• Using fallback method as primary method
  a. need a way to define "method" in config file to pass to assets/php/loop.php .

TO DO:

• CURL: Ignore hostname mismatch -> Change check.php to

"curl_setopt($handle, CURLOPT_SSL_VERIFYHOST, 0);

• Add PING as fallback to CURL
• Add authentication option
• Add option to select PING as primary method (ISSUE!)
• Add growler notifications on error?

Need to add link to the bottom of index.php which shows GIT version, like this:

Docker braanch is stuck on the version it got forked from. When you use the inbuilt updater it works until you rebuild the docker. (think of it like a snapshot)

Proposed change: add the dockerfile to each branch. OR update docker branch whem master gets updates.

Feature addition: small toggle switch to disable auto-refresh.
Code Reference: https://codemyui.com/toggle-switch-collection-using-pure-css-custom-properties/
Status: TESTING

STATUS:

• (OK) Functionality
• (OK) UI Desktop browsers: Looks dope.
• (OK) UI Android: Looks dope
• (OK) UI iOS: looks dope. FIXED: Displays switch on top of TITLE. Need to figure out how to AUTO-adjust title to smaller font size on smaller screens so there is no overlap.
• (Pending) Pushed to DEV
• (Pending) Merged with master
• (Pending) Wiki updated
• (Pending) Release published

Wiki changes for Org plug in need to change to this:

    <div style="overflow:hidden; height:270px">    
        <embed style="height:100%" width='100%' src='https://yourdomain.com/monitorr/index.min.php' />
    </div>

Add:

• Major Bugs

Add:

• Features

Change config

• adding custom images

Feedback:

I installed a turnkey-LAMP container on one of my Proxmox servers. What I was initally confused is follows:
Clone/download repository to your webserver (Suggested a Sub DIR), (So like any webserver)
Replace "YOUR SERVER NAME HERE" in assets/config.php, - (Replace with what? Just what I want to call it)
Replace "http://github.com/seanvree/monitorr" in assets/config.php, - (Replace with what?)
I also got it working once I manually installed php-curl. I know that was listed as the prereq. Just thought it could be a little clearer.

I created a Docker image for the project. It's a little tweaky because of needing to edit the config, but it works. It would be better if we could populate the config via environment variables or just use the UI to edit the settings, but again, it works.

It can be found here: https://github.com/binaryronin/monitorr-docker

ISSUE:
If config.sample.php is updated on the REPO - How do we create a NEW config.php file w/o overwriting users' custom config.php file?

Suggestions:
 - create config.sample.NEW.php?

Feature suggestion: Convert from bootstrap to Bluma

Status: Early development

Current Branch: https://github.com/Monitorr/Monitorr/tree/bluma

Progress:

• (in-dev) working branch published: https://github.com/Monitorr/Monitorr/tree/bluma
• (pending) Functionality
• (Pending) UI Desktop browsers: x
• (Pending) UI Android: x
• (Pending) UI iOS: x
• (Pending) Pushed to DEV
• (Pending) Merged with MASTER
• (Pending) Release published

To Do:

• Move clock to top left
• Add overview to top right? ie: 0/4 services "offline" type of deal?
• move refresh switch to bottom
• Add manual curl/ping function feature to run a manual check of any service via simple input form with HOST: PORT which could be accessed by "drop down/radio button, etc (TBD)"

Suggestion: Add tile for current streams / current transcodes.

Concept in progress.

Issue: Refresh page after update check