README

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