-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
347 lines (310 loc) · 13.4 KB
/
index.html
File metadata and controls
347 lines (310 loc) · 13.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>NBFC-Linux</title>
<link rel="stylesheet" href="style.css" />
</head>
<body>
<header>
<h1>NBFC-Linux</h1>
<nav>
<a href="#start">Home</a>
<a href="#downloads">Downloads</a>
<a href="#guis">Graphical Uses Interfaces</a>
<a href="#getting-started-gui">Getting Started (GUI)</a>
<a href="#getting-started-commandline">Getting Started (Command Line)</a>
<a href="/configs">Supported Models</a>
<a href="/creating-config">Creating Configuration HowTo</a>
<a href="#screenshots">Screenshots</a>
<a href="#sponsors">Sponsors</a>
<a href="#donate">Donate</a>
<a href="https://github.com/nbfc-linux/nbfc-linux" target="_blank" rel="noopener noreferrer">GitHub</a>
</nav>
</header>
<main>
<section id="start">
<p>
<b>NBFC-Linux</b> is a lightweight fan control daemon written in C.<br />
It is a port of Stefan Hirschmann’s <i>NoteBook FanControl</i> (NBFC) for Linux and offers similar functionality and configuration tools.
</p>
<h2>Features</h2>
<ul>
<li>Lightweight implementation (Service uses <b>~230KB</b> of RAM)</li>
<li>Support for a wide range of notebook models (<a href="configs/">Is my notebook model supported?</a>)</li>
<li>Graphical User Interfaces (GTK4, Qt6)</li>
<li>Configuration files can be fetched from the internet</li>
<li>Flexible fan sensor assignment via sensor name, sensor group (@GPU, @CPU), temperature file, or custom shell command</li>
</ul>
</section>
<section id="downloads">
<h2>Downloads</h2>
<table>
<thead>
<tr>
<th>Operating System</th>
<th>Download</th>
</tr>
</thead>
<tbody>
<tr>
<td>Arch Linux</td>
<td><a href="https://github.com/nbfc-linux/nbfc-linux/releases/download/0.3.19/nbfc-linux-git-0.3.18.r4.g656af52-1-x86_64.pkg.tar.zst">Download 0.3.19 (141KB)</a></td>
</tr>
<tr>
<td>Debian (Bookworm)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-linux/releases/download/0.3.19/nbfc-linux_0.3.19_amd64.deb">Download 0.3.19 (121KB)</a></td>
</tr>
<tr>
<td>Fedora 42 (Adams)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-linux/releases/download/0.3.19/fedora-nbfc-linux-0.3.19-1.x86_64.rpm">Download 0.3.19 (146KB)</a></td>
</tr>
<tr>
<td>OpenSuse (Tumbleweed)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-linux/releases/download/0.3.19/opensuse-nbfc-linux-0.3.19-1.x86_64.rpm">Download 0.3.19 (145KB)</a></td>
</tr>
</tbody>
</table>
</section>
<section id="guis">
<h2>Graphical User Interfaces</h2>
<p>NBFC-Linux comes with graphical frontends for common desktop environments.</p>
<h3>GTK4 GUI (for GNOME, XFCE, etc.)</h3>
<table>
<thead>
<tr>
<th>Operating System</th>
<th>Download</th>
</tr>
</thead>
<tbody>
<tr>
<td>Arch Linux</td>
<td><a href="https://github.com/nbfc-linux/nbfc-gtk/releases/download/0.2.1/nbfc-gtk-git-0.2.1-1-any.pkg.tar.zst">Download 0.2.1 (28KB)</a></td>
</tr>
<tr>
<td>Debian (Bookworm)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-gtk/releases/download/0.2.1/nbfc-gtk_0.2.1_amd64.deb">Download 0.2.1 (14KB)</a></td>
</tr>
<tr>
<td>Fedora 42 (Adams)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-gtk/releases/download/0.2.1/fedora-nbfc-gtk-0.2.1-1.x86_64.rpm">Download 0.2.1 (19KB)</a></td>
</tr>
<tr>
<td>OpenSuse (Tumbleweed)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-gtk/releases/download/0.2.1/opensuse-nbfc-gtk-0.2.1-1.x86_64.rpm">Download 0.2.1 (19KB)</a></td>
</tr>
</tbody>
</table>
<h3>Qt6 GUI (for KDE)</h3>
<table>
<thead>
<tr>
<th>Operating System</th>
<th>Download</th>
</tr>
</thead>
<tbody>
<tr>
<td>Arch Linux</td>
<td><a href="https://github.com/nbfc-linux/nbfc-qt/releases/download/0.4.3/nbfc-qt-git-0.4.3-1-any.pkg.tar.zst">Download 0.4.3 (124KB)</a></td>
</tr>
<tr>
<td>Debian (Bookworm)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-qt/releases/download/0.4.3/nbfc-qt_0.4.3_amd64.deb">Download 0.4.3 (112KB)</a></td>
</tr>
<tr>
<td>Fedora 42 (Adams)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-qt/releases/download/0.4.3/fedora-nbfc-qt-0.4.3-1.x86_64.rpm">Download 0.4.3 (117KB)</a></td>
</tr>
<tr>
<td>OpenSuse (Tumbleweed)</td>
<td><a href="https://github.com/nbfc-linux/nbfc-qt/releases/download/0.4.3/opensuse-nbfc-qt-0.4.3-1.x86_64.rpm">Download 0.4.3 (116KB)</a></td>
</tr>
</tbody>
</table>
</section>
<section id="getting-started-gui">
<h2>Getting Started (GUI)</h2>
<p>When running NBFC for the first time, you need to give it a configuration file for your laptop model.</p>
<p>Start the GUI with root privileges:</p>
<pre><code>sudo nbfc-qt # For NBFC-Qt
# -- or --
sudo nbfc-gtk # For NBFC-Gtk</code></pre>
<ol>
<li>
<strong>Perform update</strong> (tab <em>“Update”</em>)<br />
Click the <strong>“Update”</strong> button to fetch the latest configuration files.
</li>
<li>
<strong>Select configuration</strong> (tab <em>“Basic Configuration”</em>)<br />
<div style="border-left: 4px solid orange; padding-left: 1em; margin: 0.5em 0;">
<strong>Warning:</strong> The model name must match completely or use placeholders (like <code>XXX</code>).
</div>
<ul>
<li>Select a configuration from the dropdown menu</li>
<li>Click <strong>“Set”</strong></li>
<li>Then save using <strong>“Save”</strong></li>
</ul>
</li>
<li>
<strong>Start test mode (read-only)</strong> (tab <em>“Service”</em>)
<ul>
<li>Enable the checkbox <strong>“Start in read-only mode”</strong></li>
<li>Click <strong>“Start”</strong> – status should change to <strong>“Running”</strong></li>
</ul>
</li>
<li>
<strong>Test the configuration</strong><br />
Run a stress test in the terminal:
<pre><code>stress -c 8</code></pre>
<p>
Watch the <em>“Fans”</em> tab to see if the displayed fan speed (<strong>“Current Speed”</strong>) changes.
If it doesn't, the configuration is likely invalid!
</p>
</li>
<li>
<strong>Enable write mode</strong> (tab <em>“Service”</em>)
<ul>
<li>Stop the service (<strong>“Stop”</strong> button)</li>
<li>Uncheck <strong>“Start in read-only mode”</strong></li>
<li>Start the service again (<strong>“Start”</strong>)</li>
</ul>
</li>
<li>
<strong>Use manual or automatic fan control</strong> (tab <em>“Fans”</em>):
<ul>
<li><strong>Manual:</strong> Set fan speed directly</li>
<li><strong>Automatic:</strong> Temperature-based control via profile</li>
</ul>
</li>
</ol>
<h3>Enable Auto-Start at Boot</h3>
<p>To have NBFC-Linux start automatically on system boot:</p>
<pre><code>sudo systemctl enable nbfc_service.service</code></pre>
</section>
<section id="getting-started-commandline">
<h2>Getting Started (Command Line)</h2>
<p>When running NBFC for the first time, you need to give it a configuration file for your laptop model.</p>
<p>Follow the steps below:</p>
<ol>
<li>
<code>sudo nbfc update</code> will download the latest configuration files from the internet.
</li>
<li>
<code>sudo nbfc config --set auto</code> will try to set a configuration automatically.<br />
If this succeeds, skip to <em>Step 5</em>.
</li>
<li>
<code>nbfc config --recommend</code> will compare your <code>DMI system-product-name</code> to the available configuration file names and print a list of descending similarity.
</li>
<li>
Repeat the following until you find a working configuration:
<ul>
<li><code>sudo nbfc config --set "<MODEL>"</code> – set a configuration</li>
<li><code>sudo nbfc restart -r</code> – (re-)start the service in <em>read only</em> mode</li>
<li><code>nbfc status</code> – show the fan status</li>
<li>Let the fan turn up (and down) (e.g. using <code>stress</code>) and observe if <code>nbfc status</code> shows fan speed changes</li>
<li>If speeds are reported correctly, the config is likely valid. Proceed to <em>Step 5</em>.</li>
</ul>
</li>
<li>
<code>sudo nbfc restart</code> will (re-)start the service in <em>write mode</em> (enabling fan control)
</li>
<li>
Test fan control manually:
<ul>
<li>
<code>nbfc set -s <SPEED></code> will set the fan speed. (<code>0</code>=off, <code>100</code>=full speed)<br />
If this does not work, the specified configuration is invalid. Go back to <em>Step 4</em>.
</li>
</ul>
</li>
<li>
<code>nbfc set --auto</code> will enable <em>auto mode</em> (temperature-based automatic fan speed control as specified in configuration)
</li>
<li>
<code>sudo systemctl enable nbfc_service</code> will enable the service to start automatically on boot
</li>
</ol>
</section>
<section id="screenshots">
<h2>Screenshots</h2>
<h3>NBFC-Qt</h3>
<div class="gallery">
<figure>
<a href="img/nbfc-qt/nbfc-qt-service.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-qt/nbfc-qt-service.png" alt="NBFC-Qt Service Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-qt/nbfc-qt-fans.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-qt/nbfc-qt-fans.png" alt="NBFC-Qt Fans Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-qt/nbfc-qt-basic.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-qt/nbfc-qt-basic.png" alt="NBFC-Qt Basic Configuration Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-qt/nbfc-qt-sensors.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-qt/nbfc-qt-sensors.png" alt="NBFC-Qt Sensors Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-qt/nbfc-qt-update.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-qt/nbfc-qt-update.png" alt="NBFC-Qt Update Tab" />
</a>
</figure>
</div>
<h3>NBFC-GTK</h3>
<div class="gallery">
<figure>
<a href="img/nbfc-gtk/nbfc-gtk-service.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-gtk/nbfc-gtk-service.png" alt="NBFC-GTK Service Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-gtk/nbfc-gtk-fans.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-gtk/nbfc-gtk-fans.png" alt="NBFC-GTK Fans Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-gtk/nbfc-gtk-basic.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-gtk/nbfc-gtk-basic.png" alt="NBFC-GTK Basic Configuration Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-gtk/nbfc-gtk-sensors.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-gtk/nbfc-gtk-sensors.png" alt="NBFC-GTK Sensors Tab" />
</a>
</figure>
<figure>
<a href="img/nbfc-gtk/nbfc-gtk-update.png" target="_blank" rel="noopener noreferrer">
<img src="img/nbfc-gtk/nbfc-gtk-update.png" alt="NBFC-GTK Update Tab" />
</a>
</figure>
</div>
</section>
<section id="sponsors">
<h2>Sponsors</h2>
<p>No sponsors yet</p>
</section>
<section id="donate" style="text-align: center">
<h2 style="font-size: 1.8rem">Support This Project</h2>
<p style="font-size: 1rem; margin-bottom: 1.5rem;">
If you find NBFC-Linux helpful, consider supporting the development by making a small donation. Your support helps keep the project alive and evolving.
</p>
<a href="https://paypal.me/BenjaminAbendroth" target="_blank" rel="noopener noreferrer"
style="display: inline-block; background-color: #0070ba; color: white; padding: 0.75rem 1.5rem; font-size: 1rem; text-decoration: none; border-radius: 8px;">
Donate via PayPal
</a>
</section>
</main>
<footer>
© 2025 NBFC-Linux. Open Source under the GPL 3 License.
</footer>
</body>
</html>