src/server/description.txt

   1 [DESCRIPTION]
   2
   3 /psensor-server is a/
   4
   5 It provides a JSON Web service which can be used by psensor(1) to
   6 monitor remotely the hardware sensors of a computer.
   7
   8 It can provide information about:
   9   * the temperature of the motherboard and CPU sensors (using lm\-sensors).
  10   * the temperature of the Hard Disk Drives (using hddtemp).
  11   * the rotation speed of the fans (using lm\-sensors).
  12
  13 The entry point of the JSON Web service is:
  14 http://hostname:3131/api/1.0/sensors.
  15
  16 It is also possible to connect to the psensor\-server with a browser, a
  17 simple Web page is displaying the sensors information and the CPU
  18 usage.
  19
  20 If run in debug mode, psensor\-server can be stopped by sending an HTTP
  21 request with the URL 'http://hostname:port/api/1.0/server/stop'.
  22
  23 [WARNING]
  24
  25 psensor\-server does not provide any way to restrict the connection to
  26 the HTTP server, worst, no effort has been made against malicious HTTP
  27 attacks.  You should make the psensor\-server port available only to a
  28 network or computer you trust by using the usual network security
  29 tools of the system (for example, iptables(8) ).
  30
  31 [SEE ALSO]
  32
  33 psensor(1), sensors(1), sensors\-detect(8)