switch to my usual email
[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 Debian
42 ------
43
44 For Debian, the binary and source packages are available in the wheezy
45 (testing) and sid (unstable) repositories.
46
47 Debian package information are available at:
48 http://packages.qa.debian.org/p/psensor.html
49
50 Ubuntu
51 ------
52
53 For Ubuntu, the easy way to install Psensor and Psensor-server is to
54 use the dedicated PPA.
55
56 For the last stable version:
57 sudo apt-get apt-add-repository ppa:/jfi/psensor
58 sudo apt-get update
59 sudo apt-get install psensor
60
61 For the last development version:
62 sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
63 sudo apt-get update
64 sudo apt-get install psensor
65 sudo apt-get install psensor-server
66
67 Alternatively, you can download Ubuntu binary packages from:
68 http://wpitchoune.net/psensor/files/ubuntu/
69 The manual installation of the psensor and psensor-server packages
70 requires also the installation of psensor-common which contains
71 the multiple languages support.
72
73 Installation from source archive
74 --------------------------------
75
76 Psensor compilation requires:
77
78  * make/gcc     
79  * lm-sensors
80  * library sensors4
81  * library gtk2
82  * library gconf2
83  * help2man 
84  * library libnotify (optional)
85  * library libappindicator (optional)
86  * library libXNVCtrl (optional)
87  * library json0 and curl (optional, required for remote monitoring)
88  * library unity (>=v3.4.2, optional)
89
90 Psensor-server compilation requires:
91  * make/gcc     
92  * lm-sensors
93  * library sensors4
94  * help2man 
95  * library libmicrohttpd 
96  * library json0
97  * library LUA5.1 (optional, required to enable HTML page generation    
98  of the psensor-server webserver)
99  * library gtop2 (optional, required for CPU usage)
100
101 Compilation and Installation Steps
102 ----------------------------------
103
104  * Extract files from the source archive
105  * Compilation:
106    ./configure
107    make clean all
108    
109  * Installation:
110    make install
111
112  * Start the sensor detection script: 'sensors-detect' and follows the
113 instructions
114
115  * Verify the sensor detection by running: 'sensors'
116
117  * Run 'psensor'
118
119 Contact
120 -------
121 Bugs and comments can be sent to jeanfi@gmail.com
122 Home page: http://wpitchoune.net/psensor