README

   1 = Psensor README
   2 :docinfo2:
   3 :toc:
   4 :icons: font
   5
   6 Introduction
   7 ------------
   8
   9 Psensor is a graphical hardware monitoring application for Linux.
  10
  11 It draws realtime charts and raises alerts about:
  12
  13  * the temperature of the motherboard and CPU sensors (using
  14    lm-sensors).
  15  * the temperature of the NVidia GPUs (using XNVCtrl).
  16  * the temperature of ATI GPUs (using ATI ADL SDK).
  17  * the temperature of the Hard Disk Drives (using hddtemp, libatasmart
  18    or udisks2).
  19  * the rotation speed of the fans.
  20  * the temperature of a remote computer.
  21  * the CPU load.
  22
  23 Alerts are using Desktop Notification and a specific GTK+ status icon.
  24
  25 For Ubuntu users, Psensor is providing an Application Indicator which turns
  26 red under alert and a menu for quickly check all sensors.
  27
  28 It is possible to monitor remotely a computer:
  29
  30  * start +psensor-server+ on the remote computer.
  31
  32  * start +psensor+ using: +psensor --url=http://hostname:3131+.
  33
  34 +psensor-server+ is a minimal Web server, a Web browser can be used to
  35 monitor the remote computer by opening the URL:
  36 +http://hostname:3131+.
  37
  38 [WARNING]
  39 +psensor-server+ does not provide any way to restrict the connection
  40 to the HTTP server, worst, no effort has been made against malicious
  41 HTTP attacks.  You should make the +psensor-server+ port available
  42 only to a network or computer you trust by using the usual network
  43 security tools of the system (for example:
  44 http://www.netfilter.org/projects/iptables/index.html[iptables]).
  45
  46 Installation Using Distribution Packages
  47 ----------------------------------------
  48
  49 Debian
  50 ~~~~~~
  51
  52 For Debian, the binary and source packages are available in the
  53 Wheezy, unstable and testing repositories.
  54
  55 Debian package information is available at:
  56 http://packages.qa.debian.org/p/psensor.html.
  57
  58 To do the installation:
  59 --------------------------------------------
  60 sudo apt-get install psensor psensor-server
  61 --------------------------------------------
  62
  63 Ubuntu
  64 ~~~~~~
  65
  66 Since Ubuntu Oneiric (11.10), psensor is available in the universe
  67 repository of Ubuntu.
  68
  69 To install +psensor+ or +psensor-server+:
  70 ------------------------------------
  71 sudo apt-get install psensor
  72 sudo apt-get install psensor-server
  73 ------------------------------------
  74
  75 Or search them in the Ubuntu Software Center.
  76
  77 For other Ubuntu releases or user the more recent release, the easiest
  78 way is to use the dedicated PPA.
  79
  80 Last stable version:
  81 -------------------------------------------------
  82 sudo apt-get apt-add-repository ppa:/jfi/psensor
  83 sudo apt-get update
  84 sudo apt-get install psensor
  85 sudo apt-get install psensor-server
  86 -------------------------------------------------
  87
  88 Last development version which should not contain major bugs:
  89 ----------------------------------------------------------
  90 sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
  91 sudo apt-get update
  92 sudo apt-get install psensor
  93 sudo apt-get install psensor-server
  94 ----------------------------------------------------------
  95
  96 Daily trunk build which may contain major bugs and partialy
  97 implemented features:
  98 -------------------------------------------------------------
  99 sudo apt-get apt-add-repository ppa:/jfi/psensor-daily-trunk
 100 sudo apt-get update
 101 sudo apt-get install psensor
 102 sudo apt-get install psensor-server
 103 -------------------------------------------------------------
 104
 105 Installation From Source Archive
 106 --------------------------------
 107
 108 +psensor+ and +psensor-server+ can be compiled and installed on any
 109 modern GNU/Linux distribution.
 110
 111 Compilation Prerequisites
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 The compilation of +psensor+ requires:
 115
 116  * make
 117  * gcc (or llvm)
 118  * lm-sensors
 119  * library sensors4
 120  * library gtk3 >=3.4
 121  * help2man (optional, required to produce the manpage)
 122  * asciidoctor (optional, required to produce the html version of the
 123    faq)
 124  * cppcheck (optional, static source checker)
 125  * library libnotify (optional)
 126  * library libappindicator >= 3.0 (optional)
 127  * library libXNVCtrl (optional)
 128  * library json-c >= 0.11.99 and curl (optional, required for remote monitoring)
 129  * library unity (>=v3.4.2, optional)
 130  * library gtop2 (optional, required for CPU usage)
 131  * library atasmart (optional, for disk monitoring)
 132  * library udisk2 (optional, for disk monitoring)
 133
 134 The specific requirements for +psensor-server+:
 135
 136  * library libmicrohttpd
 137  * library json-c >= 0.11.99
 138
 139 Compilation and Installation Steps
 140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 141
 142 1. download the source archive from: http://wpitchoune.net/psensor/files
 143 2. Extract files from the source archive
 144 3. Compilation: +./configure;make clean all+
 145 4. Installation:  +make install+ (require to have root permission)
 146 5. Start the sensor detection script: +sensors-detect+ and follows the
 147 instructions. Reboot or activate the kernel modules which have
 148 been found.
 149 6. Run: +psensor+
 150
 151 ATI/AMD GPU Support
 152 ~~~~~~~~~~~~~~~~~~~
 153
 154 When the OpenSource ATI driver is used, the monitoring
 155 information is available throw lm-sensors and does not require the
 156 following instructions.
 157
 158 When the proprietary ATI driver(Catalyst) is used, the build is
 159 requiring an additional library.
 160
 161 Download the
 162 http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx[ATI ADL SDK]
 163 and extracts the files of the archive into a directory [dir].
 164
 165 Replace the step 3. of the above section by +./configure
 166 --with-libatiadl=[dir]+ where +[dir]+ must be the directory where you
 167 have extracted the ATI ADL SDK. Other steps are indentical.
 168
 169 Contact
 170 -------
 171
 172 Bugs and comments can be sent to jeanfi@gmail.com.
 173
 174 Home page: http://wpitchoune.net/psensor