aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
Diffstat (limited to 'about.html')
-rw-r--r--about.html104
1 files changed, 104 insertions, 0 deletions
diff --git a/about.html b/about.html
new file mode 100644
index 0000000..30290f6
--- /dev/null
+++ b/about.html
@@ -0,0 +1,104 @@
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
3<head>
4 <meta charset="utf-8" />
5 <meta name="generator" content="pandoc" />
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
7 <meta name="author" content="Robert Alessi" />
8 <title>The my-x200 package – README file</title>
9 <style type="text/css">
10 code{white-space: pre-wrap;}
11 span.smallcaps{font-variant: small-caps;}
12 span.underline{text-decoration: underline;}
13 div.column{display: inline-block; vertical-align: top; width: 50%;}
14 </style>
15</head>
16<body>
17<header>
18<h1 class="title">The my-x200 package – README file</h1>
19<p class="subtitle">A Debian/Devuan service dedicated to Thinkpads X200</p>
20<p class="author">Robert Alessi</p>
21</header>
22<h1 id="license-and-disclamer">License and Disclamer</h1>
23<p><code>my-x200</code> - A Debian/Devuan service dedicated to Thinkpads X200 Copyright (C) 2021 Robert Alessi <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p>
24<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.</p>
25<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
26<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
27<h1 id="overview">Overview</h1>
28<p><code>my-x200</code> is a simple script primarily designed to make the distinctive whining noise of Thinkpads X200 disappear. But it can also be used on other laptops.</p>
29<p>It is written to be used on <a href="https://www.devuan.org/">Devuan GNU+Linux</a> but it should work on other Debian-based distributions.</p>
30<h2 id="configuration">Configuration</h2>
31<p>Once installed, <code>my-x200</code> is configured by editing <code>/etc/default/my-x200</code>.</p>
32<h2 id="noise-removal">Noise Removal</h2>
33<p>Set the variable <code>is_thinkpad_x200</code> to <code>yes</code> (which is the default value). The default frequency rate should work. It may be change by modifying the value of <code>PWMFREQ_RATE</code>.</p>
34<h2 id="privacy-settings">Privacy Settings</h2>
35<p><code>/etc/default/my-x200</code> also provides a “Privacy settings” section: if <code>enable_privacy</code> is set to <code>true</code>, then the wired internet interface that may or may not be connected to the internet will have its MAC address spoofed at startup. (The wireless interfaces must also be spoofed, but this can be handled by wpa_supplicant: see below.) Additionally, <code>my-x200</code> will delete <code>/var/lib/dhcpcd/duid</code>, and use <code>/proc/sys/kernel/random/boot_id</code> to generate a new DUID-LLT based file with an updated timestamp. A new DUID is generated each time the computer is started.</p>
36<h2 id="backup">Backup</h2>
37<p>Finally <code>my-x200</code> has the ability to backup essential files or directories—for instance to a backup disk mounted inside the dock. Of course, the backup process is triggered on certain conditions only:</p>
38<ol type="1">
39<li>The option must be enabled in the <code>/etc/default/my-x200</code> file.</li>
40<li>The disk must be mounted.</li>
41<li>An (empty) <code>dobackup</code> file must be present in the backup directory.</li>
42</ol>
43<p>Then, once these conditions are met, the backup process is triggered whenever the service is stopped.</p>
44<h1 id="installation">Installation</h1>
45<ol type="1">
46<li>Clone this repository locally.</li>
47<li>Do <code>make debian</code>.</li>
48<li>Install the generated <code>my-x200</code> <code>.deb</code> package as root with <code>dpkg -i</code>.</li>
49<li>Edit <code>/etc/default/my-x200</code>.</li>
50</ol>
51<p>Alternatively, a <code>.deb</code> file ready to be installed and its associated <code>.dsc</code> source package file are provided in this repository. Once these two files and the corresponding two source files <code>.orig.tar.gz</code> and <code>debian.tar.xz</code> are downloaded in the same directory, it is advisable to verify the signature like so:—</p>
52<ol type="1">
53<li>Download <code>my-x200</code> master tarball: &lt;&gt;</li>
54<li>Import the developer’s <a href="https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7">public PGP key</a>, like so: <code>gpg --recv-keys 8085C8C7</code></li>
55<li>Verify the signature: <code>dscverify --keyring ~/.gnupg/pubring.gpg my-x200_&lt;ver&gt;.dsc</code> (Replace <code>&lt;ver&gt;</code> with the actual release number.)</li>
56</ol>
57<p>For a good GPG cheat sheet, see <a href="https://guides.library.illinois.edu/data_encryption/gpgcheatsheet">here</a>.</p>
58<h2 id="use-and-recommended-configuration">Use and recommended configuration</h2>
59<blockquote>
60<p>The command <code>rc-update</code> that is used below refer to <code>openrc</code>. Other init systems use other commands. Please adapt.</p>
61</blockquote>
62<p>It is advisable to use my-x200 in conjunction with <code>wpa_supplicant</code> and <code>dhcpcd</code> only. In addition, <code>wpagui</code> and <code>dhcpcd-gtk</code> are also recommended to be able to configure the network from systray applets. If so, <code>wicd</code> may be disabled: as root, simply do <code>rc-update del wicd</code>.</p>
63<h3 id="wpa_supplicant"><code>wpa_supplicant</code></h3>
64<p>For this to work properly, it is important to have these lines in <code>/etc/wpa_supplicant/wpa_supplicant.conf</code>:</p>
65<pre><code>ctrl_interface=DIR=/run/wpa_supplicant GROUP=netdev
66update_config=1
67mac_addr=1
68preassoc_mac_addr=1</code></pre>
69<p>(For additional security, do (as root) <code>chmod 700 /etc/wpa_supplicant</code>)</p>
70<h3 id="dhcpcd"><code>dhcpcd</code></h3>
71<p>And these settings in <code>/etc/dhcpcd.conf</code>:</p>
72<pre><code>hostname &quot;localhost&quot;
73hostname_short</code></pre>
74<h3 id="etcnetworkinterfaces"><code>/etc/network/interfaces</code></h3>
75<p>Finally, <code>/etc/network/interfaces</code> should look like this:—</p>
76<pre><code># This file describes the network interfaces available on your system
77# and how to activate them. For more information, see interfaces(5).
78
79source /etc/network/interfaces.d/*
80
81# The loopback network interface
82auto lo
83iface lo inet loopback
84
85# The primary network interface
86allow-hotplug eth0
87iface eth0 inet manual
88
89# wlan interface
90allow-hotplug wlan0
91iface wlan0 inet manual
92wpa-roam /etc/wpa_supplicant/wpa_supplicant.conf</code></pre>
93<h2 id="do-not-use">Do Not Use</h2>
94<ol type="1">
95<li>NetworkManager</li>
96<li>Avahi</li>
97</ol>
98<p>To disable <code>avahi</code>, do (as root):</p>
99<pre><code>rc-update del avahi-daemon
100chmod -x /etc/network/if-up.d/avahi-daemon</code></pre>
101<h2 id="further-information">Further Information</h2>
102<p>More information in <code>my-x200</code> initd file: <a href="https://git.robertalessi.net/my-x200/tree/my-x200.confd" class="uri">https://git.robertalessi.net/my-x200/tree/my-x200.confd</a></p>
103</body>
104</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-21 20:52:02 +0000