Invite Codes
Invite codes are how new devices join a localWiki workspace. Only workspace admins and owners can generate them.
Generating an Invite Code
- Open the Admin Panel > Devices tab.
- Click Invite in the top-right corner.
- A one-time invite code is generated automatically with a fixed 1-hour expiry.
- Copy the code using the Copy Code button and share it with the person setting up the new device via a secure channel (e.g. direct message, in-person).
Each invite code is a single-use cryptographic token. Once a device uses it to join, the code is invalidated.
Invite Code Expiry
All invite codes expire after 1 hour. The invite modal shows a live countdown timer and a progress bar indicating how much time remains. When the countdown reaches zero, the code is marked as expired.
If a code expires before being used, click Generate New to create a fresh one.
The expiry is fixed at 1 hour and cannot be configured. This keeps the window of exposure short.
The Invite Flow
When a user receives an invite code, they enter it during localWiki’s setup:
Admin generates code -> shares with teammate
|
Teammate installs localWiki -> enters invite code
|
Device authenticates -> appears in Pending Approval
|
Admin approves device -> sync beginsThe invite code is used to establish a secure key exchange. After the new device connects, it appears in the Pending Approval section of the Devices panel, where an admin must approve it before sync begins.
Regenerating Codes
Click Generate New in the invite modal at any time to invalidate the current code and create a new one. This is useful if you suspect a code was shared with the wrong person.