Skip to content

Commit 7e92612

Browse files
authored
Merge pull request #191 from cgwalters/fix-install-doc
docs/install: Various minor fixes
2 parents 8b7f190 + 182d79f commit 7e92612

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

docs/install.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ other options.
4646

4747
Here's an example:
4848

49-
```
50-
$ podman run --privileged --pid=host --security-opt label=type:unconfined_t <image> bootc install --target-no-signature-verification /path/to/disk
49+
```sh
50+
podman run --privileged --pid=host --security-opt label=type:unconfined_t <image> bootc install --target-no-signature-verification /path/to/disk
5151
```
5252

5353
Note that while `--privileged` is used, this command will not perform any
@@ -87,7 +87,7 @@ in that case you will need to specify `--skip-fetch-check`.
8787
The container image must define its default install configuration. For example,
8888
create `/usr/lib/bootc/install/00-exampleos.toml` with the contents:
8989

90-
```
90+
```toml
9191
[install]
9292
root-fs-type = "xfs"
9393
```
@@ -104,7 +104,6 @@ prior setting.
104104
The one exception to host requirements today is that the host must
105105
have `skopeo` installed. This is a bug; more information in [this issue](https://github.com/containers/bootc/issues/81).
106106

107-
108107
## Installing an "unconfigured" image
109108

110109
The bootc project aims to support generic/general-purpose operating
@@ -123,7 +122,7 @@ Other tools in this space are:
123122
- [systemd-firstboot](https://www.freedesktop.org/software/systemd/man/systemd-firstboot.html)
124123
- [gnome-initial-setup](https://gitlab.gnome.org/GNOME/gnome-initial-setup)
125124

126-
The general idea here is that things like users, passwords and ssh keys
125+
The general idea here is that things like users, passwords and ssh keys
127126
are dynamically created on first boot (and in general managed per-system);
128127
the configuration comes from a place *external* to the image.
129128

@@ -150,7 +149,7 @@ from the default ostree `/etc` which may be locally writable.
150149
The `AuthorizedKeysFile` invocation below then configures sshd to look
151150
for keys in this location.
152151

153-
```
152+
```Dockerfile
154153
FROM <image>
155154
RUN mkdir -p /usr/etc-system/ && \
156155
echo 'AuthorizedKeysFile /usr/etc-system/%u.keys' >> /etc/ssh/sshd_config.d/30-auth-system.conf && \
@@ -164,7 +163,6 @@ the files are underneath `/usr`. To rotate or change the set of keys,
164163
one would build a new container image. Client systems using `bootc upgrade`
165164
will transactionally update to this new system state.
166165

167-
168166
## More advanced installation
169167

170168
The basic `bootc install` logic is really a pretty small (but opinionated) wrapper
@@ -199,7 +197,6 @@ storage or filesystem setups, but reuses the "top half" of the logic.
199197
For example, a goal is to change [Anaconda](https://github.com/rhinstaller/anaconda/)
200198
to use this.
201199

202-
203200
### Using `bootc install-to-filesystem --replace=alongside`
204201

205202
This is a variant of `install-to-filesystem`, which maximizes convenience for using
@@ -212,8 +209,8 @@ support the root storage setup already initialized.
212209

213210
The core command should look like this:
214211

215-
```
216-
$ podman run --privileged -v /:/target --pid=host --security-opt label=type:install_t \
212+
```sh
213+
podman run --privileged -v /:/target --pid=host --security-opt label=type:unconfined_t \
217214
<image> \
218215
bootc install-to-filesystem --replace=alongside /target
219216
```

0 commit comments

Comments
 (0)