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