README

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