style
[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
59
60 Ubuntu
61 ------
62
63 Notes about installation on Ubuntu is available at:
64 http://wpitchoune.net/blog/psensor/ubuntu-integration
65
66 Since Ubuntu Oneiric (11.10), psensor is available in the universe
67 repository of Ubuntu.
68
69 For other Ubuntu releases, the easy way to install Psensor and
70 Psensor-server is to use the dedicated PPA.
71
72 For the last stable version:
73 sudo apt-get apt-add-repository ppa:/jfi/psensor
74 sudo apt-get update
75 sudo apt-get install psensor
76
77 For the last development version:
78 sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
79 sudo apt-get update
80 sudo apt-get install psensor
81 sudo apt-get install psensor-server
82
83 Alternatively, you can download Ubuntu binary packages from:
84 http://wpitchoune.net/psensor/files/ubuntu/
85 The manual installation of the psensor and psensor-server packages
86 requires also the installation of psensor-common which contains
87 the multiple languages support.
88
89 Centos 6
90 --------
91
92 psensor can be compiled on Centos 6.0, by installing the following
93 packages:
94 gcc gtk2-devel GConf2-devel help2man gettext-devel libnotify-deval
95 lm_sensors-devel libgtop2-devel
96
97 As microhttpd and json-c libraries are not available in the standard centos
98 repository, psensor-server cannot be compiled and the remote
99 monitoring feature of psensor will not be available.
100
101 Installation from source archive
102 --------------------------------
103
104 Psensor compilation requires:
105
106  * make/gcc     
107  * lm-sensors
108  * library sensors4
109  * library gtk2 (>= 2.18)
110  * library gconf2
111  * help2man 
112  * library libnotify (optional)
113  * library libappindicator (optional)
114  * library libXNVCtrl (optional)
115  * library json0 and curl (optional, required for remote monitoring)
116  * library unity (>=v3.4.2, optional)
117  * library gtop2 (optional, required for CPU usage)
118
119 Psensor-server compilation requires:
120  * make/gcc     
121  * lm-sensors
122  * library sensors4
123  * help2man 
124  * library libmicrohttpd 
125  * library json0
126  * library gtop2 (optional, required for CPU usage)
127
128 Compilation and Installation Steps
129 ----------------------------------
130
131  * Extract files from the source archive
132  * Compilation:
133    ./configure
134    make clean all
135    
136  * Installation:
137    make install
138
139  * Start the sensor detection script: 'sensors-detect' and follows the
140 instructions
141
142  * Verify the sensor detection by running: 'sensors'
143
144  * Run 'psensor'
145
146 Contact
147 -------
148 Bugs and comments can be sent to jeanfi@gmail.com
149 Home page: http://wpitchoune.net/psensor