www/psensor/README.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="UTF-8">
   5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <meta name="generator" content="Asciidoctor 1.5.4">
   8 <title>Psensor README</title>
   9 <link rel="stylesheet" href="./../style.css">
  10 <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
  11 <script src="nav.js"></script>
  12 <link rel="stylesheet" href="/font-awesome/css/font-awesome.min.css">
  13 </head>
  14 <body class="article">
  15 <div id="header">
  16 <h1>Psensor README</h1>
  17 </div>
  18 <div id="content">
  19 <div class="sect1">
  20 <h2 id="_introduction">Introduction</h2>
  21 <div class="sectionbody">
  22 <div class="paragraph">
  23 <p>Psensor is a graphical hardware monitoring application for Linux.</p>
  24 </div>
  25 <div class="paragraph">
  26 <p>It draws realtime charts and raises alerts about:</p>
  27 </div>
  28 <div class="ulist">
  29 <ul>
  30 <li>
  31 <p>the temperature of the motherboard and CPU sensors (using
  32 lm-sensors).</p>
  33 </li>
  34 <li>
  35 <p>the temperature of the NVidia GPUs (using XNVCtrl).</p>
  36 </li>
  37 <li>
  38 <p>the temperature of ATI GPUs (using ATI ADL SDK).</p>
  39 </li>
  40 <li>
  41 <p>the temperature of the Hard Disk Drives (using hddtemp, libatasmart
  42 or udisks2).</p>
  43 </li>
  44 <li>
  45 <p>the rotation speed of the fans.</p>
  46 </li>
  47 <li>
  48 <p>the temperature of a remote computer.</p>
  49 </li>
  50 <li>
  51 <p>the CPU load.</p>
  52 </li>
  53 </ul>
  54 </div>
  55 <div class="paragraph">
  56 <p>Alerts are using Desktop Notification and a specific GTK+ status icon.</p>
  57 </div>
  58 <div class="paragraph">
  59 <p>For Ubuntu users, Psensor is providing an Application Indicator which turns
  60 red under alert and a menu for quickly check all sensors.</p>
  61 </div>
  62 <div class="paragraph">
  63 <p>It is possible to monitor remotely a computer:</p>
  64 </div>
  65 <div class="ulist">
  66 <ul>
  67 <li>
  68 <p>start psensor-server on the remote computer.</p>
  69 </li>
  70 <li>
  71 <p>start psensor using: psensor --url=http://hostname:3131.</p>
  72 </li>
  73 </ul>
  74 </div>
  75 <div class="paragraph">
  76 <p>psensor-server is a minimal Web server, a Web browser can be used to
  77 monitor the remote computer by opening the URL:
  78 http://hostname:3131.</p>
  79 </div>
  80 <div class="admonitionblock warning">
  81 <table>
  82 <tr>
  83 <td class="icon">
  84 <div class="title">Warning</div>
  85 </td>
  86 <td class="content">
  87 psensor-server does not provide any way to restrict the connection
  88 to the HTTP server, worst, no effort has been made against malicious
  89 HTTP attacks.  You should make the psensor-server port available
  90 only to a network or computer you trust by using the usual network
  91 security tools of the system (for example:
  92 <a href="http://www.netfilter.org/projects/iptables/index.html">iptables</a>).
  93 </td>
  94 </tr>
  95 </table>
  96 </div>
  97 </div>
  98 </div>
  99 <div class="sect1">
 100 <h2 id="_installation_using_distribution_packages">Installation Using Distribution Packages</h2>
 101 <div class="sectionbody">
 102 <div class="sect2">
 103 <h3 id="_debian">Debian</h3>
 104 <div class="paragraph">
 105 <p>For Debian, the binary and source packages are available in the
 106 Wheezy, unstable and testing repositories.</p>
 107 </div>
 108 <div class="paragraph">
 109 <p>Debian package information is available at:
 110 <a href="http://packages.qa.debian.org/p/psensor.html" class="bare">http://packages.qa.debian.org/p/psensor.html</a>.</p>
 111 </div>
 112 <div class="paragraph">
 113 <p>To do the installation:</p>
 114 </div>
 115 <div class="listingblock">
 116 <div class="content">
 117 <pre>sudo apt-get install psensor psensor-server</pre>
 118 </div>
 119 </div>
 120 </div>
 121 <div class="sect2">
 122 <h3 id="_ubuntu">Ubuntu</h3>
 123 <div class="paragraph">
 124 <p>Since Ubuntu Oneiric (11.10), psensor is available in the universe
 125 repository of Ubuntu.</p>
 126 </div>
 127 <div class="paragraph">
 128 <p>To install psensor or psensor-server:</p>
 129 </div>
 130 <div class="listingblock">
 131 <div class="content">
 132 <pre>sudo apt-get install psensor
 133 sudo apt-get install psensor-server</pre>
 134 </div>
 135 </div>
 136 <div class="paragraph">
 137 <p>Or search them in the Ubuntu Software Center.</p>
 138 </div>
 139 <div class="paragraph">
 140 <p>For other Ubuntu releases or user the more recent release, the easiest
 141 way is to use the dedicated PPA.</p>
 142 </div>
 143 <div class="paragraph">
 144 <p>Last stable version:</p>
 145 </div>
 146 <div class="listingblock">
 147 <div class="content">
 148 <pre>sudo apt-get apt-add-repository ppa:/jfi/psensor
 149 sudo apt-get update
 150 sudo apt-get install psensor
 151 sudo apt-get install psensor-server</pre>
 152 </div>
 153 </div>
 154 <div class="paragraph">
 155 <p>Last development version which should not contain major bugs:</p>
 156 </div>
 157 <div class="listingblock">
 158 <div class="content">
 159 <pre>sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
 160 sudo apt-get update
 161 sudo apt-get install psensor
 162 sudo apt-get install psensor-server</pre>
 163 </div>
 164 </div>
 165 <div class="paragraph">
 166 <p>Daily trunk build which may contain major bugs and partialy
 167 implemented features:</p>
 168 </div>
 169 <div class="listingblock">
 170 <div class="content">
 171 <pre>sudo apt-get apt-add-repository ppa:/jfi/psensor-daily-trunk
 172 sudo apt-get update
 173 sudo apt-get install psensor
 174 sudo apt-get install psensor-server</pre>
 175 </div>
 176 </div>
 177 </div>
 178 </div>
 179 </div>
 180 <div class="sect1">
 181 <h2 id="_installation_from_source_archive">Installation From Source Archive</h2>
 182 <div class="sectionbody">
 183 <div class="paragraph">
 184 <p>psensor and psensor-server can be compiled and installed on any
 185 modern GNU/Linux distribution.</p>
 186 </div>
 187 <div class="sect2">
 188 <h3 id="_compilation_prerequisites">Compilation Prerequisites</h3>
 189 <div class="paragraph">
 190 <p>The compilation of psensor requires:</p>
 191 </div>
 192 <div class="ulist">
 193 <ul>
 194 <li>
 195 <p>make</p>
 196 </li>
 197 <li>
 198 <p>gcc (or llvm)</p>
 199 </li>
 200 <li>
 201 <p>lm-sensors</p>
 202 </li>
 203 <li>
 204 <p>library sensors4</p>
 205 </li>
 206 <li>
 207 <p>library gtk3 &gt;=3.4</p>
 208 </li>
 209 <li>
 210 <p>help2man (optional, required to produce the manpage)</p>
 211 </li>
 212 <li>
 213 <p>asciidoc (optional, required to produce the html version of the
 214 faq)</p>
 215 </li>
 216 <li>
 217 <p>cppcheck (optional, static source checker)</p>
 218 </li>
 219 <li>
 220 <p>library libnotify (optional)</p>
 221 </li>
 222 <li>
 223 <p>library libappindicator &gt;= 3.0 (optional)</p>
 224 </li>
 225 <li>
 226 <p>library libXNVCtrl (optional)</p>
 227 </li>
 228 <li>
 229 <p>library json-c &gt;= 0.11.99 and curl (optional, required for remote monitoring)</p>
 230 </li>
 231 <li>
 232 <p>library unity (&gt;=v3.4.2, optional)</p>
 233 </li>
 234 <li>
 235 <p>library gtop2 (optional, required for CPU usage)</p>
 236 </li>
 237 <li>
 238 <p>library atasmart (optional, for disk monitoring)</p>
 239 </li>
 240 <li>
 241 <p>library udisk2 (optional, for disk monitoring)</p>
 242 </li>
 243 </ul>
 244 </div>
 245 <div class="paragraph">
 246 <p>The specific requirements for psensor-server:</p>
 247 </div>
 248 <div class="ulist">
 249 <ul>
 250 <li>
 251 <p>library libmicrohttpd</p>
 252 </li>
 253 <li>
 254 <p>library json-c &gt;= 0.11.99</p>
 255 </li>
 256 </ul>
 257 </div>
 258 </div>
 259 <div class="sect2">
 260 <h3 id="_compilation_and_installation_steps">Compilation and Installation Steps</h3>
 261 <div class="olist arabic">
 262 <ol class="arabic">
 263 <li>
 264 <p>download the source archive from: <a href="http://wpitchoune.net/psensor/files" class="bare">http://wpitchoune.net/psensor/files</a></p>
 265 </li>
 266 <li>
 267 <p>Extract files from the source archive</p>
 268 </li>
 269 <li>
 270 <p>Compilation: ./configure;make clean all</p>
 271 </li>
 272 <li>
 273 <p>Installation:  make install (require to have root permission)</p>
 274 </li>
 275 <li>
 276 <p>Start the sensor detection script: sensors-detect and follows the
 277 instructions. Reboot or activate the kernel modules which have
 278 been found.</p>
 279 </li>
 280 <li>
 281 <p>Run: psensor</p>
 282 </li>
 283 </ol>
 284 </div>
 285 </div>
 286 <div class="sect2">
 287 <h3 id="_ati_amd_gpu_support">ATI/AMD GPU Support</h3>
 288 <div class="paragraph">
 289 <p>When the OpenSource ATI driver is used, the monitoring
 290 information is available throw lm-sensors and does not require the
 291 following instructions.</p>
 292 </div>
 293 <div class="paragraph">
 294 <p>When the proprietary ATI driver(Catalyst) is used, the build is
 295 requiring an additional library.</p>
 296 </div>
 297 <div class="paragraph">
 298 <p>Download the
 299 <a href="http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx">ATI ADL SDK</a>
 300 and extracts the files of the archive into a directory [dir].</p>
 301 </div>
 302 <div class="paragraph">
 303 <p>Replace the step 3. of the above section by ./configure
 304 --with-libatiadl=[dir] where [dir] must be the directory where you
 305 have extracted the ATI ADL SDK. Other steps are indentical.</p>
 306 </div>
 307 </div>
 308 </div>
 309 </div>
 310 <div class="sect1">
 311 <h2 id="_contact">Contact</h2>
 312 <div class="sectionbody">
 313 <div class="paragraph">
 314 <p>Bugs and comments can be sent to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p>
 315 </div>
 316 <div class="paragraph">
 317 <p>Home page: <a href="http://wpitchoune.net/psensor" class="bare">http://wpitchoune.net/psensor</a></p>
 318 </div>
 319 </div>
 320 </div>
 321 </div>
 322 <div id="footer">
 323 <div id="footer-text">
 324 Last updated 2016-06-14 10:13:47 CEST
 325 </div>
 326 </div>
 327 </body>
 328 </html>