Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/configure-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ Fioup includes a few ways to work with configuration data.

### `config-check`

`fioup config-check` makes a request to the [Device Gateway](https://docs.foundries.io/latest/reference-manual/ota/ota-architecture.html)
`sudo fioup config-check` makes a request to the [Device Gateway](https://docs.foundries.io/latest/reference-manual/ota/ota-architecture.html)
to check for new configuration data. If configuration has changed, it will
download and extract the data.

### `config-extract`

Devices often need access to configuration data in the boot process before
networking is available and the daemon might run. `fioup config-extract` will
networking is available and the daemon might run. `sudo fioup config-extract` will
decrypt and extract the current copy of configuration data, `/var/sota/config.encrypted`,
to `/run/secrets` if its availble.

### `daemon mode`

By default, `fioup daemon` checks with the Device Gateway for new configuration
data during each update interval. This can be disabled with `fioup daemon --fioconfig=0`.
By default, `sudo fioup daemon` checks with the Device Gateway for new configuration
data during each update interval. This can be disabled with `sudo fioup daemon --fioconfig=0`.

## Example

Expand Down
6 changes: 2 additions & 4 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
1. Update the `apt` package index and install packages needed to use the fioup `apt` repository:

```
sudo apt update
sudo apt install -y apt-transport-https ca-certificates curl gnupg
sudo apt update && sudo apt install -y apt-transport-https ca-certificates curl gnupg
```

1. Download the public signing key for the package repositories:
Expand All @@ -30,8 +29,7 @@
1. Install fioup

```
sudo apt update
sudo apt install fioup
sudo apt update && sudo apt install fioup
```

A systemd service, `fioup`, is created in a disabled state. This service
Expand Down
34 changes: 1 addition & 33 deletions docs/register-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,44 +14,12 @@ The registration command does several things:
* Configure `$HOME/.docker/config.json` to use this helper for
authenticating with `hub.foundries.io`.

## As Root (Recommended)
To register a device run the following command:

```
sudo fioup register --factory <FACTORY_NAME> --name <NAME_FOR_DEVICE>
```

## As Non-Root User (Advanced)

Provide the user (`$USER`) with read/write access to the directory used by `fioup` to store configuration files, metadata, and Compose App blobs.

```
sudo chown -R $USER /var/sota
```

Add the user to the Docker group so that `fioup` —when invoked by this user—can load app container images into the Docker Engine storage (requires access to the Docker Unix socket at `/var/run/docker.sock`).
You need to logout and log back in to apply this change.

```
sudo usermod -aG docker $USER

```

The host/device is now ready for registration with your Factory.

```
fioup register --factory <FACTORY_NAME> --name <NAME_FOR_DEVICE>
```

>[!NOTE]
> If the credential helper is not installed (i.e. fioup was not
> installed with as a Debian package), then the user must have a writable
> directory in their `PATH` for fioup to setup the credential helper.
> Alternatively, you can create a symlink with something like:
>
> ```
> sudo ln -s <path to fioup> /usr/local/bin/docker-credential-fioup
> ```

## Example

```
Expand Down
Loading