Skip to content

Commit e718ed8

Browse files
committed
docs: add links to FDO server documentation
Signed-off-by: Klara Necasova <knecasov@redhat.com>
1 parent cf12aca commit e718ed8

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/fdo-client-documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ FDO enables zero-touch device onboarding and secure device identity management f
1212
## Prerequisites
1313

1414
- Linux system
15-
- FDO servers deployed and accessible (Manufacturer, Rendezvous, Owner). See the FDO server documentation for server deployment.
15+
- FDO servers deployed and accessible (Manufacturer, Rendezvous, Owner). See the "[FIDO Device Onboarding User Guide](https://github.com/fido-device-onboard/go-fdo-server/blob/main/docs/user-guide/README.md)", the section "Server installation" for server deployment.
1616
- Network connectivity between the device and FDO servers
1717

1818
## Installing the FDO client
@@ -57,7 +57,7 @@ To verify that device initialization completed successfully, see [Verifying devi
5757
> - The Ownership Voucher must be transferred from the Manufacturer server to the Owner server.
5858
> - The Owner server must register with the Rendezvous server (via the TO0 protocol).
5959
>
60-
> These are server-side operations. For more information, see the FDO server documentation.
60+
> These are server-side operations. For more information, see the "[Quickstart: Install, Configure and Run FDO](https://github.com/fido-device-onboard/go-fdo-server/blob/main/docs/user-guide/quick-start.md)", the section "Basic Onboarding Flow (Device DI → voucher → TO0 → TO2)", step 3.
6161
6262
### Phase 2: Onboarding at first boot
6363

@@ -240,7 +240,7 @@ During onboarding, the FDO Owner server can invoke the following service modules
240240
| `fdo.upload` | Upload files from the device to the Owner server. Relative paths resolve from `default-working-dir`. |
241241
| `fdo.wget` | Download files from an HTTP server to the device. Relative paths resolve from `default-working-dir`. Temporary files are created in `default-working-dir`. |
242242

243-
All service modules are enabled by default. The `default-working-dir` is configured as an onboarding option (see [Onboarding options](#onboarding-options)). The Owner server configuration determines which modules are invoked during onboarding. See the FDO server documentation for server-side configuration.
243+
All service modules are enabled by default. The `default-working-dir` is configured as an onboarding option (see [Onboarding options](#onboarding-options)). The Owner server configuration determines which modules are invoked during onboarding. See the "[Configuration File Reference](https://github.com/fido-device-onboard/go-fdo-server/blob/main/docs/user-guide/server-config.md)", section "Service Info Configuration (FSIM Operations)" for server-side configuration.
244244

245245
## Using a TPM
246246

@@ -313,7 +313,7 @@ The Rendezvous server does not have a record for this device. This means the Own
313313
3. The Owner server is configured with the correct Rendezvous server address.
314314
4. The correct Ownership Voucher was transferred. The GUID in the voucher must match the GUID in the device credential. Use `go-fdo-client print --blob /boot/device_credential` (or `--tpm /dev/tpmrm0` when using a TPM) to check the device GUID.
315315

316-
These are server-side operations. For more information, see the FDO server documentation. The `onboard` command retries automatically. If it continues to fail, check the Owner and Rendezvous server logs.
316+
These are server-side operations. For more information, see the "[Quickstart: Install, Configure and Run FDO](https://github.com/fido-device-onboard/go-fdo-server/blob/main/docs/user-guide/quick-start.md)", the section "Basic Onboarding Flow (Device DI → voucher → TO0 → TO2)", step 3. The `onboard` command retries automatically. If it continues to fail, check the Owner and Rendezvous server logs.
317317

318318
### Onboarding fails with "no rendezvous information found that's usable for the device"
319319

0 commit comments

Comments
 (0)