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