Skip to content

Commit

Permalink
docs: mention --stream option
Browse files Browse the repository at this point in the history
  • Loading branch information
koehlma committed Nov 27, 2023
1 parent 2a6d096 commit 942d914
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions www/docs/guide/over-the-air-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,19 @@ Note that a persistent overlay that may exist for the spare partition is deleted
To avoid the overlay from being discarded, use the `--keep-overlay` option when installing the update.
Please be aware that this may lead to incompatibilities between the overlay and the freshly installed system.

Rugpi also has experimental support for streaming updates directly to the SD card instead of first storing the image and then installing it.
To this end, use the option `--stream`.
With `--stream`, you can use `-` as artifact path to install an image streamed via stdin to Rugpi Ctrl.
This also allows using compressed images.
For instance, to download, decompress, and install an image on-the-fly, use:

```shell
curl <url to the image> | xz -d | rugpi-ctrl update install --stream -
```

Streaming an image is faster because the data only has to be written to the SD card once.
Furthermore, it has the advantage that the image does not take up precious space on the data partition during the installation.

[^2]: How this happens is outside the scope of Rugpi's core functionality.

### Committing an Update
Expand Down
2 changes: 1 addition & 1 deletion www/src/theme/prism-lang-shell.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Prism.languages.shell = {
function: {
pattern: /(docker|rugpi-ctrl|\.\/run-bakery|\bgit\b|\bdocker\b)/
pattern: /(\sxz\s|\bcurl\b|docker|rugpi-ctrl|\.\/run-bakery|\bgit\b|\bdocker\b)/
},
constant: {
pattern: /(true|false)/,
Expand Down

0 comments on commit 942d914

Please sign in to comment.