aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 3d89f8832551c87cf4e48f7c9480e65ae68eb53e (plain)
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
# Open Suck

**Latest changes based off OpenBSD 7.5**

Lightweight Desktop installer for OpenBSD based on the suckless philosophy.
Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.)

![Screenshot of dwm running on
OpenBSD](https://git.sr.ht/~bt/open-suck-installer/blob/master/screenshot.png)

Successfully installed on:

- ThinkPad X201
- ThinkPad X220
- ThinkPad X260
- Lenovo M73 Tiny

## What You Get

The Open Suck installer gives you the absolute barebones desktop experience:

- `dwm` for window management
- `ranger` for your file browser
- `qutebrowser` as your core web browser
- `aerc` for your terminal-based mail client
- `slock` for screen locking
- `scrot`/`slop` for simple screenshot utilities
- `feh` for your image/file viewing
- `dunst` for notifications

## Downloading

1. Download the latest OpenBSD iso and follow the installer
2. Install `git`, `vim`, `bash`
3. Edit/create doas permissions (`/etc/doas.conf`):

```
permit nopass :wheel
```

Now logout and log back in as your main user.

---

Clone the main installer project:

`git clone https://git.sr.ht/~bt/open-suck-installer`

`cd open-suck-installer`

## Installing

1) Install dependencies by running `./install-dependencies.sh`. The script will simply read required packages from `dependencies.txt` and run `pkg_add`.
2) Compile and install suckless software by running the `./install.sh`
3) Core program files (dwm, dmenu, etc) will be placed inside a newly created `open-suck-core` directory. Feel free to delete, rename or move this.

## TL;DR

```sh
cd open-suck-installer # CD into this repository
doas sh ./install-dependencies.sh # Install OpenBSD packages
doas sh ./install.sh # Install suckless tools
cp .xinitrc ~/.xinitrc # Apply .xinitrc
```

Reboot the machine. Log in as your main user. Run:

```
startx
```

---

## Optimizing OpenBSD

### Improving Battery Performance

Properly setup apmd:

```
rcctl enable apmd
rcctl set apmd flags -A
rcctl start apmd
```

### Setup WiFi

> The following assumes you have installed/setup the proper firmware updates for your hardware.


```
ifconfig iwn0 up
ifconfig iwn0 scan
echo "join WIFI-NAME wpakey PASSPHRASE" >> /etc/hostname.iwn0
echo "dhcp" >> /etc/hostname.iwn0
echo "inet6 autoconf" >> /etc/hostname.iwn0
echo "up powersave" >> /etc/hostname.iwn0
dhclient iwn0
```

Take note of the `iwn0`, as this might differ on your machine.

You might also need to run `doas sh /etc/netstart` after.