mirror of
https://github.com/bjango/istatserverlinux.git
synced 2025-10-21 23:18:07 +00:00
man page and readme updates
This commit is contained in:
2
autogen
2
autogen
@@ -1,6 +1,6 @@
|
|||||||
#! /bin/sh
|
#! /bin/sh
|
||||||
|
|
||||||
# Jazzio Labs Autotools support (modified for istatd)
|
# Jazzio Labs Autotools support (modified for istatserver)
|
||||||
|
|
||||||
# Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Mo McRoberts.
|
# Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Mo McRoberts.
|
||||||
#
|
#
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
# istatserver
|
# istatserver
|
||||||
|
|
||||||
A system monitoring daemon that is used in conjunction with [iStat for iOS](https://bjango.com/ios/istat/) and [iStat for macOS](https://bjango.com/mac/istat/) to remotely monitor computers.
|
istatserver is a system monitoring daemon that is used in conjunction with [iStat for iOS](https://bjango.com/ios/istat/) and [iStat for macOS](https://bjango.com/mac/istat/) to remotely monitor computers.
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@@ -1,9 +1,9 @@
|
|||||||
.Dd 2009-05-17
|
.Dd 2009-05-17
|
||||||
.Dt istatd 1
|
.Dt istatserver 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm istatd
|
.Nm istatserver
|
||||||
.Nd serving statistics to your istat iphone application
|
.Nd system monitoring daemon
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.Nm
|
.Nm
|
||||||
.Op Fl c Ar config
|
.Op Fl c Ar config
|
||||||
@@ -13,11 +13,8 @@
|
|||||||
|
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm
|
.Nm
|
||||||
is a server daemon for serving statistics to your istat iphone application.
|
is a system monitoring daemon that collects and stores performance monitoring data.
|
||||||
.Nm
|
You can then use iStat for iOS and iStat for macOS to remotely monitor your computer.
|
||||||
collects data such as cpu, mem, network and disk usage and keeps the history.
|
|
||||||
once connecting from the iphone and entering the lock code this data will be
|
|
||||||
sent to the iphone and shown in fancy graphs.
|
|
||||||
|
|
||||||
.Sh OPTIONS
|
.Sh OPTIONS
|
||||||
.Bl -tag -width -indent-three
|
.Bl -tag -width -indent-three
|
||||||
@@ -25,8 +22,6 @@ sent to the iphone and shown in fancy graphs.
|
|||||||
Print version number
|
Print version number
|
||||||
.It Fl d
|
.It Fl d
|
||||||
Run in the process in background
|
Run in the process in background
|
||||||
.It Fl c Ar config
|
|
||||||
Use a custom config file search path
|
|
||||||
.It Fl a Ar address
|
.It Fl a Ar address
|
||||||
Listen for network connections on this address
|
Listen for network connections on this address
|
||||||
.It Fl p Ar port
|
.It Fl p Ar port
|
||||||
@@ -38,13 +33,15 @@ Group to run daemon as
|
|||||||
.It Fl -pid Ar path
|
.It Fl -pid Ar path
|
||||||
Custom pid file location
|
Custom pid file location
|
||||||
.It Fl -clear-sessions
|
.It Fl -clear-sessions
|
||||||
Clear all saved authorized sessions.
|
Reset list of authorized devices.
|
||||||
|
.It Fl -verify
|
||||||
|
Verify sqlite history database.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
.Sh FILES
|
.Sh FILES
|
||||||
/etc/istat.conf
|
/usr/local/etc/istatserver/istatserver.conf
|
||||||
.Pp
|
.Pp
|
||||||
Configuration for network settings, lock code, running user, devices to monitor and more.
|
Configuration for passcode, server port and more.
|
||||||
.El
|
.El
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr istat.conf 5
|
.Xr istatserver.conf 5
|
||||||
|
@@ -10,7 +10,7 @@ server_code 12345
|
|||||||
# server_user istat
|
# server_user istat
|
||||||
# server_group istat
|
# server_group istat
|
||||||
# server_socket /tmp/istatserver.sock
|
# server_socket /tmp/istatserver.sock
|
||||||
# server_pid /var/run/istatserver/istatserver.pid
|
# server_pid /var/run/istatserver.pid
|
||||||
|
|
||||||
# Set to 1 if you want to disable sqlite history storage.
|
# Set to 1 if you want to disable sqlite history storage.
|
||||||
disable_history_storage 0
|
disable_history_storage 0
|
||||||
|
@@ -1,37 +1,42 @@
|
|||||||
.Dd 2009-05-17
|
.Dd 2009-05-17
|
||||||
.Dt istat.conf 5
|
.Dt istatserver.conf 5
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm istat.conf
|
.Nm istatserver.conf
|
||||||
.Nd configuration file for istatd
|
.Nd configuration file for istatserver
|
||||||
|
|
||||||
.Sh OPTIONS
|
.Sh OPTIONS
|
||||||
.Bl -tag -width -indent-three
|
.Bl -tag -width -indent-three
|
||||||
.It network_addr
|
.It network_addr
|
||||||
Address to bind (default: 0.0.0.0)
|
Address to bind (default: 0.0.0.0)
|
||||||
|
|
||||||
.It network_port
|
.It network_port
|
||||||
Port to bind (default: 5109)
|
Port to bind (default: 5109)
|
||||||
|
|
||||||
.It server_code
|
.It server_code
|
||||||
Lock code needed when connecting to the server for the first time.
|
Lock code needed when connecting to the server for the first time.
|
||||||
|
|
||||||
.It server_socket
|
.It server_socket
|
||||||
Location of the unix socket. (default: /tmp/istatd.sock)
|
Location of the unix socket. (default: /tmp/istatserver.sock)
|
||||||
|
|
||||||
.It server_pid
|
.It server_pid
|
||||||
Location of the pid. (default: /var/run/istat/istatd.pid)
|
Location of the pid. (default: /var/run/istatserver.pid)
|
||||||
|
|
||||||
.It server_user
|
.It server_user
|
||||||
User to switch to when entering daemon mode. It's not recommended to use high privilaged users like root due to security reasons. Defaults to root if the user doesn't exist. (default: istat)
|
User to switch to when entering daemon mode. It's not recommended to use high privilaged users like root due to security reasons. Defaults to root if the user doesn't exist. (default: istat)
|
||||||
|
|
||||||
.It server_group
|
.It server_group
|
||||||
Group to switch to when entering daemon mode. Defaults to root if the group doesn't exist. (default: istat)
|
Group to switch to when entering daemon mode. Defaults to root if the group doesn't exist. (default: istat)
|
||||||
.It monitor_disk
|
|
||||||
Can contain search path to device or mount point. When specifying more than one disk, use paranteses around the list:
|
|
||||||
|
|
||||||
monitor_disk /dev/sda1
|
.It disable_history_storage
|
||||||
|
Set to 1 if you want to disable history storage (not recommended unless you have very limited disk space).
|
||||||
|
|
||||||
monitor_disk ( /dev/sda1 /dev/sda2 )
|
|
||||||
|
.It disk_disable_filtering
|
||||||
|
Set to 1 if you want to disable all mount path based disk filtering (excludes filesystems that you are unlikely to want to monitor).
|
||||||
|
|
||||||
.It disk_mount_path_label
|
.It disk_mount_path_label
|
||||||
Set to 1 if you want to use mount path as label instead of the device name.
|
Set to 1 if you want to use mount path as label instead of the device name.
|
||||||
.It disk_filesystem_label
|
|
||||||
Set to 1 if you want to probe the filesystem for disk label, will override the mount path and device name.
|
|
||||||
.It disk_rename_label
|
.It disk_rename_label
|
||||||
Set custom disk label. Will override all other labels. You can use either the device name or mount path:
|
Set custom disk label. Will override all other labels. You can use either the device name or mount path:
|
||||||
|
|
||||||
@@ -40,4 +45,4 @@ disk_rename_label /dev/sda1 "root"
|
|||||||
disk_rename_label /home "home"
|
disk_rename_label /home "home"
|
||||||
.El
|
.El
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr istatd 1
|
.Xr istatserver 1
|
||||||
|
@@ -131,7 +131,8 @@ int main(int argc, char ** argv)
|
|||||||
|
|
||||||
// Load server generated config file
|
// Load server generated config file
|
||||||
string generated_path = config_directory + "istatserver_generated.conf";
|
string generated_path = config_directory + "istatserver_generated.conf";
|
||||||
Config configGenerated(arguments.get("c", generated_path.c_str()));
|
// Config configGenerated(arguments.get("c", generated_path.c_str()));
|
||||||
|
Config configGenerated(generated_path.c_str());
|
||||||
configGenerated.parse();
|
configGenerated.parse();
|
||||||
configGenerated.validate();
|
configGenerated.validate();
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user