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