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

**Latest changes based off OpenBSD 7.6**

* Lightweight Desktop installer for OpenBSD based on the suckless philosophy
* Licensed under [Mixed](https://git.btxx.org/open-suck/tree/LICENSE)
* Discussion, patches etc. go to the
  [list](https://lists.sr.ht/~bt/open-suck-devel)

---

### Desktop Screenshot

![Screenshot of dwm running on OpenBSD via desktop](/screenshots/open-suck-76.png)

### Laptop Screenshot

![Screenshot of dwm running on OpenBSD desktop](/screenshots/open-suck-75.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
- `firefox` 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
```

Also add your desired user to the `wheel` group:

```
usermod -G wheel bt
```

Now logout and log back in as your main user.

---

Clone the main installer project:

`git clone https://git.btxx.org/open-suck`

`cd open-suck`

## Installing

1. Install dependencies
2. Compile and install suckless software

## TL;DR

```sh
cd open-suck # CD into this repository
doas sh ./install-dependencies.sh # Install OpenBSD packages
```

### Installing on a Laptop

```
doas sh ./install-laptop.sh
```

### Installing on a Desktop

```
doas sh ./install-desktop.sh
```

Copy over `.xinitrc`:

```
cp .xinitrc ~/.xinitrc # Apply .xinitrc
```

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

```
startx
```

---

## Optimizing OpenBSD

### Improving Battery Performance / Enabling Sleep

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.

Create a new file `hostname.iwn0` (change the extensions to what is reported
via `ifconfig`)

```
join WIFI-NAME wpakey PASSPHRASE
dhcp
inet6 autoconf
up powersave
```

Then run the following:

```
ifconfig iwn0 up
```

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