Add a Portal, Domain, and App to a Project
This tutorial walks through adding an attendee portal to a project, assigning a domain, and installing a plugin app so attendees can access it. By the end you'll have a live portal URL running your plugin.
- A project must exist (see Create an All-Access Blank Project)
- A plugin template must exist with at least one published version (see Create a New Plugin App)
- A domain must be configured in your team's Domains settings, or you can use a platform-provided subdomain
Time: ~5 minutes
Part 1 — Add a Portal
1. Open the Project
From your team dashboard, click Projects and open the project you want to configure.
2. Navigate to Portals
In the project dashboard, click Portals in the left-hand navigation.
3. Create a New Portal
Click + Add Portal (or New Portal) to open the portal creation form.
4. Configure the Portal
Fill in the portal details:
| Field | Description | Example |
|---|---|---|
| Name | Internal name for this portal | Attendee Portal |
| Slug | URL path segment for this portal | attendee |
| Theme | Optional — choose an installed theme or leave blank |
Click Save to create the portal.
Part 2 — Assign a Domain
5. Open Portal Settings
After creating the portal, click on it to open its settings. Navigate to the Domain tab.
6. Assign a Domain
You have two options:
Option A — Platform subdomain (fastest for testing): The platform automatically assigns a subdomain based on your team and project slug. This is available immediately with no DNS configuration required.
Option B — Custom domain: Click Assign Domain, then select a domain previously configured in your team's Domains settings. The domain must already be pointing to the platform via DNS.
7. Verify the Portal URL
The portal detail page will show the full URL once a domain is assigned. Copy it — you'll use this to test your plugin after the next steps.
Part 3 — Install a Plugin App
8. Navigate to Pages
In the project dashboard, click Pages in the left-hand navigation.
9. Install a Plugin
Click + Add Page (or Install Plugin) to open the plugin browser.
10. Select Your Plugin
Browse or search for the plugin you want to install. Click your plugin to select it, then choose the version to install.
Only published versions appear in the installer. If your plugin only has a draft version, publish it first from the Developer Hub.
11. Configure the Installation
The installer will prompt you to resolve dependencies and fill in any settings defined in the plugin version:
- Dependencies — map each declared dependency to a concrete project resource (e.g., map
attendee_profileto the project's attendee model) - Settings — configure any developer-defined options with project-specific values
12. Assign to a Portal
Select which portal this page should appear in and configure its navigation position (visible in nav, hidden, etc.).
13. Save the Installation
Click Save (or Install) to complete the installation.
14. Visit the Portal
Open the portal URL from Step 7 in your browser. Your plugin page should now be accessible to attendees.
What's Next
- Git Repos & Build Pipelines — push code changes and trigger automated builds
- DevKit Basics — set up local development with hot reload
- Plugin Development Overview — deep dive into versioning, dependencies, and settings