Overview¶
This guide takes you from nothing to a working gateway, one step at a time. You need no prior knowledge. Every step has the same five parts:
- Why this step: what it is for.
- You need: what to have ready.
- Do this: exactly what to click or type.
- You should see: a picture of the result.
- If not: what to do when it looks different.
Words in bold are buttons, fields and menu entries, written exactly as they appear on screen. When a word is new, it links to the glossary, which explains it in one or two sentences.
Steps 2 to 6 happen in your web browser. Steps 7 and 8 happen on the gateway itself.
Getting help. Some steps say "contact support". When you are signed in, click Support in the menu on the left, directly under Documentation. When you are not signed in, open the sign-up page (step 2) and click Contact at the very bottom. Both open the contact page of the platform's provider, Pallax, in a new tab; write to the email address listed there. Say which step you are at and your company name. Never send passwords or private keys.
How it works¶
The platform sets up your gateways automatically: you enter a gateway once, switch it on, and it fetches its settings by itself. You describe the settings once, in a template, and assign it to your gateways. Each gateway proves who it is with a security chip, the TPM, so only your real gateways get your settings. After the first start it calls the platform regularly (a check-in, by default once an hour) and picks up changes by itself; the console shows how far each gateway has got and whether it is still calling in. Afterwards a changed template reaches it at its next check-in, and you can lock, re-provision or delete it (see More device actions).
The steps¶
- Sign up and confirm your email: Create your organisation and your own login.
- Complete your company data: Check and complete the company data used for contracts and invoices.
- Invite colleagues and choose their roles: Give colleagues their own login and a role (optional).
- Create your first template: Create the set of settings your gateways receive.
- Add a device: Tell the platform which gateways are yours.
- Put the agent on the gateway: Set the platform address for the agent on the gateway.
- First boot: The platform checks the gateway and sends your settings.
Background. How the platform tells a genuine gateway from a copy, and which certificates a manufacturer provides: How device identity works. You do not need it for the steps above.
About these docs¶
WLPC (White-Label Provisioning Cloud) provisions and manages gateway devices for organisations, from manufacturing batch to a claimed, configured device.
Three roles¶
| Role | Does | Uses |
|---|---|---|
| OEM | Produces device batches, imports them from a manufacturing CSV, uploads the trust anchor that lets the platform recognize the batch, hands organisations a way to claim them | Bulk import and claim, Register your device CA |
| Organisation (customer) | Claims devices, adds test devices manually, edits config templates, manages the device fleet day to day | Add device, Bulk import and claim's claim step, Edit device, Edit template |
| End customer | Claims their own device with a claim code or order number — nothing else. Needs no manufacturer certificate, CA, or fingerprint. | The claim step in Bulk import and claim |
The same account can act as both OEM and organisation: once signed in, the menu shows a FLEET group (your own devices and templates), an OEM group (orders) and an ORGANISATION group (members, audit history, company data); see Sign in.