A cross-platform remote monitoring tool written in Golang for system information gathering, making it available through a JSON API.

The main purpose of this project is to provide highly available data of CPU, RAM, Disks, Network, Processes and so on, to make use of them in applications such as web administration panels or mobile apps.

curl + jq demo

• Installation
  • Download
  • Build
• Running
• Commands
• Docker
• Web Panel
• QR Code
• Usage
  • Example
• Api v1
  • Available Endpoints
  • JSON Data References
• Settings
• Platform Support
• Powered by

https://github.com/bitcav/nitr/releases/latest

Note: go version 1.13 or higher is required building it from the source.

git clone https://github.com/bitcav/nitr.git

cd nitr
go build

Linux

./nitr

Windows You can double click the .exe file or type in cmd

nitr.exe

the server will start listening on port 8000 by default

Help:

nitr -h

Change Password:

nitr passwd

Get api key:

nitr key

Print Qr Code:

nitr qr

Build image using command:

docker build -t nitr . 

Run container:

docker run -d -p 8000:8000 nitr:latest

Go to http://localhost:8000 in your web browser

Access with default password: 123456

The QR Code contains the exact same information displayed in the Host Info Panel formatted as JSON.

Requesting system info with HTTP Get Method through the API endpoints passing the "x-api-key" header with your api key as value and you will get success response.

• Requesting CPU Information.

With Curl.

curl -X Get 'http://localhost:8000/api/v1/cpu' -H 'x-api-key:yourapikeyhere'

With Powershell.

 Invoke-RestMethod -Uri http://localhost:8000/api/v1/cpu -H @{"x-api-key"="yourapikeyhere"}

JSON Response:

{
	"vendor":"GenuineIntel",
	"model":"Intel(R) Core(TM) i7-4810MQ CPU @ 2.80GHz",
	"cores":4,
	"threads":8,
	"frecuency":3800,
	"usage":8.354430379674321,
	"usageEach":[
				9.803921568623954,
				7.692307692348055,
				4.166666666635087,
				4.166666666698246,
				6.122448979565321,
				6.12244897961267,
				4.081632653074482,
				5.88235294118696
	]
}

http://localhost:8000/api/v1

These endpoints allow you to get System and Hardware information about your host. Check the example for a better understanding.

JSON Object

JSON Object

JSON Array of Objects

🔒 Requires running nitr with elevated privileges

JSON Object

JSON Array of Objects

JSON Array of Objects

JSON Array of Objects

JSON Object

JSON Array of Objects

JSON Array of Objects

JSON Object

🔒 Requires running nitr with elevated privileges

JSON Object

🔒 Requires running nitr with elevated privileges

JSON Object

🔒 Requires running nitr with elevated privileges

JSON Array of Objects

The following settings are located in the config.ini file

By default, the web server starts on port 8000.

port: 3000

If true, opens your default web browser on server startup.

open_browser_on_startup: true

If true, logs are saved in nitr.log file, otherwise logs are printed out to console.

save_logs: true

If true, server starts using HTTPS protocol. Certificate and Key must be provided

ssl_enabled: true
ssl_certificate: /path/to/file.crt
ssl_certificate_key: /path/to/file.key

Windows

Tested:

• Windows 10
• Windows 7 SP1

Linux

Tested:

• Ubuntu Linux 20.04 LTS
• Debian Linux 10
• Manjaro Linux 20

• Fiber - The web framework used
• bbolt - Database
• UIKit - Front-End framework
• gopsutil - psutil for Golang
• ghw - Golang HardWare discovery/inspection library
• go-smbios - Detection and access to System Management BIOS