updated doc with libatasmart information
[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  * the cpu load.
15
16 Alarms using Desktop Notification can be set to each sensor to notify
17 high temperatures.
18
19 For Ubuntu users, Psensor is providing an Application Indicator to
20 alert users when a temperature is too high.
21
22 To monitor the temperature of a remote computer:
23
24  * start psensor-server on the remote computer. The default port is
25    3131 and can be changed by using the '--port=PORT' command line
26    option.
27
28  * start psensor with the '--url' option: psensor
29   --url=http://hostname:3131
30
31 WARNING: 
32 psensor-server does not provide any way to restrict the connection to
33 the HTTP server, worst, no effort has been made against malicious HTTP
34 attacks.  You should make the psensor-server port available only to a
35 network or computer you trust by using the usual network security
36 tools of the system (for example, iptables).
37
38   
39 Installation
40 ------------
41
42 Psensor can be compiled and installed on any modern linux
43 distribution.
44
45 Debian
46 ------
47
48 For Debian, the binary and source packages are available in the wheezy
49 (testing) and sid (unstable) repositories.
50
51 Debian package information are available at:
52 http://packages.qa.debian.org/p/psensor.html
53
54 Compilation requires the following packages:
55
56 gettext libgtk-3-dev libgconf2-dev libnotify-dev libsensors4-dev
57 help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev
58 libgtop2-dev libatasmart-dev
59
60 Debian kfreebsd
61 ---------------
62
63 Compilation requires the following packages:
64 gcc libgtk2.0-dev libsensors4-dev libgconf2-dev help2man
65 libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev
66 libatasmart-dev
67
68 Ubuntu
69 ------
70
71 Notes about installation on Ubuntu is available at:
72 http://wpitchoune.net/blog/psensor/ubuntu-integration
73
74 Since Ubuntu Oneiric (11.10), psensor is available in the universe
75 repository of Ubuntu.
76
77 For other Ubuntu releases, the easy way to install Psensor and
78 Psensor-server is to use the dedicated PPA.
79
80 For the last stable version:
81 sudo apt-get apt-add-repository ppa:/jfi/psensor
82 sudo apt-get update
83 sudo apt-get install psensor
84
85 For the last development version:
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 Centos 6
92 --------
93
94 psensor can be compiled on Centos 6.0, by installing the following
95 packages:
96 gcc gtk2-devel GConf2-devel help2man gettext-devel libnotify-deval
97 lm_sensors-devel libgtop2-devel
98
99 As microhttpd and json-c libraries are not available in the standard centos
100 repository, psensor-server cannot be compiled and the remote
101 monitoring feature of psensor will not be available.
102
103 ATI/AMD GPU Support
104 -------------------
105
106 To compile Psensor with ATI support on Ubuntu:
107
108  * installs the usual Psensor build dependencies and fglrx ubuntu
109    package.
110
111  * downloads the ATI ADL SDK from:
112    http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx and
113    extracts the files of the archive into a directory [dir].
114
115  * configure the build environment: 
116    ./configure --with-libatiadl=[dir]   
117    where [dir] must be the directory where you have extracted the ATI
118    ADL SDK.
119
120  * then follow usual GNU autotools compilation:
121    make clean all
122    make install
123
124 Installation from source archive
125 --------------------------------
126
127 Psensor compilation requires:
128
129  * make/gcc     
130  * lm-sensors
131  * library sensors4
132  * library gtk2 (>= 2.18)
133  * library gconf2
134  * help2man 
135  * library libnotify (optional)
136  * library libappindicator (optional)
137  * library libXNVCtrl (optional)
138  * library json0 and curl (optional, required for remote monitoring)
139  * library unity (>=v3.4.2, optional)
140  * library gtop2 (optional, required for CPU usage)
141  * library atasmart (optional, for disk monitoring)
142
143 Psensor-server compilation requires:
144  * make/gcc     
145  * lm-sensors
146  * library sensors4
147  * help2man 
148  * library libmicrohttpd 
149  * library json0
150  * library gtop2 (optional, required for CPU usage)
151  * library atasmart (optional, for disk monitoring)
152
153 Compilation and Installation Steps
154 ----------------------------------
155
156  * Extract files from the source archive
157  * Compilation:
158    ./configure
159    make clean all
160    
161  * Installation:
162    make install
163
164  * Start the sensor detection script: 'sensors-detect' and follows the
165    instructions
166
167  * Verify the sensor detection by running: 'sensors'
168
169  * Run 'psensor'
170
171 Contact
172 -------
173 Bugs and comments can be sent to jeanfi@gmail.com
174 Home page: http://wpitchoune.net/psensor