Your first project¶
A project is the unit of isolation in SimpleOTA. Devices, firmware, deployments, build numbers, and API tokens are all scoped to a project.
Create¶
- Open the dashboard.
- Click Projects → New project.
- Give it a name. The slug is generated from the name; use Edit next to
the field if you want to change it. Lowercase and hyphenated works best:
office-thermostat,sea-buoys-v2. - Save.
Neither can be changed later
There is no rename, for the name or the slug. Deleting and recreating is the only way to change them, and that takes the project's devices, artifacts and build counter with it.
Find your project id¶
Open the project. Under its name is a Project ID, a UUID, with a copy button.
That UUID is what the API and your CI pipeline use to address the project;
the slug is a human label and appears in no API path. You will need it as
SIMPLEOTA_PROJECT_ID when you set up GitHub
Actions or GitLab CI.
It is not a secret.
Generate a project API token¶
Project-scoped tokens are how devices and CI pipelines authenticate.
- Open the project.
- On the project page, find the Project API tokens card and click Issue token.
- Copy the token immediately. It is shown once; SimpleOTA only stores a salted hash.
- Give it a meaningful name (
ci-upload-bot,factory-flash-rig) so you can revoke individual tokens later without rotating the world.
Token scope
A project token can register devices and upload artifacts in that project only. Personal API tokens (PATs) span all projects you own; use them for human/admin operations, not for shipping devices.