(no commit message)
[psensor.git] / README
1 Psensor - Temperature Monitoring For Linux
2 ------------------------------------------
3
4 Psensor is a graphical temperature monitor for Linux.
5
6 It can monitor:
7
8   * the temperature of the motherboard and CPU sensors (using
9     lm-sensors).
10   * the temperature of the NVidia GPUs (using XNVCtrl).
11   * the temperature of the Hard Disk Drives (using hddtemp).
12   * the rotation speed of the fans (using lm-sensors).
13   * the temperature of a remote computer.
14
15 Alarms using Desktop Notification can be set to each sensor to notify
16 high temperatures.
17
18 For Ubuntu users, Psensor is providing an Application Indicator to
19 alert users when a temperature is too high.
20
21 To monitor the temperature of a remote computer:
22
23   * start psensor-server on the remote computer. The default port is
24     3131 and can be changed by using the '--port=PORT' command line
25     option.
26
27   * start psensor with the '--url' option: 
28   psensor --url=http://hostname:3131
29
30 WARNING: 
31 psensor-server does not provide any way to restrict the connection to
32 the HTTP server, worst, no effort has been made against malicious HTTP
33 attacks.  You should make the psensor-server port available only to a
34 network or computer you trust by using the usual network security
35 tools of the system (for example, iptables).
36
37   
38 Installation
39 ------------
40
41 Ubuntu
42 ------
43
44 For Ubuntu, the easy way to install Psensor and Psensor-server is to
45 use the dedicated PPA.
46
47 For the last stable version:
48 sudo apt-get apt-add-repository ppa:/jfi/psensor
49 sudo apt-get update
50 sudo apt-get install psensor
51
52 For the last development version:
53 sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
54 sudo apt-get update
55 sudo apt-get install psensor
56 sudo apt-get install psensor-server
57
58 Alternatively, you can download Ubuntu binary packages from:
59 http://wpitchoune.net/psensor/files/ubuntu/
60 The manual installation of the psensor and psensor-server packages
61 requires also the installation of psensor-common which contains
62 the multiple languages support.
63
64 Installation from source archive
65 --------------------------------
66
67 Psensor compilation requires:
68
69  * make/gcc     
70  * lm-sensors
71  * library sensors4
72  * library gtk2
73  * library gconf2
74  * help2man 
75  * library libnotify (optional)
76  * library libappindicator (optional)
77  * library libXNVCtrl (optional)
78  * library json0 and curl (optional, required for remote monitoring)
79
80 Psensor-server compilation requires:
81  * make/gcc     
82  * lm-sensors
83  * library sensors4
84  * help2man 
85  * library libmicrohttpd 
86  * library json0
87  * library LUA5.1 (optional, required to enable HTML page generation    
88  of the psensor-server webserver)
89  * library gtop2 (optional, required for CPU usage)
90
91 Compilation and Installation Steps
92 ----------------------------------
93
94  * Extract files from the source archive
95  * Compilation:
96    ./configure
97    make clean all
98    
99  * Installation:
100    make install
101
102  * Start the sensor detection script: 'sensors-detect' and follows the
103 instructions
104
105  * Verify the sensor detection by running: 'sensors'
106
107  * Run 'psensor'
108
109 Contact
110 -------
111 Bugs and comments can be sent to wpitchoune@gmail.com
112 Home page: http://wpitchoune.net/psensor