Create a portal
A portal is a space at <slug>.pealboard.com where customers, partners or
internal staff without a GitHub account submit requests and follow them.
Every request is one GitHub issue in a repository you chose. The customer never sees GitHub, never needs an account there, and is never billed.
A workspace can have several portals: one per customer, one per product, or one public one. The Free plan allows 1, Team allows up to 5, Business is unlimited.
Create one
Section titled “Create one”- Go to Portals.
- Select New portal.
- Fill in:
- Portal name — what customers see in the header and in email subjects.
- Portal address — the subdomain,
<slug>.pealboard.com. Letters, numbers and hyphens. - Request prefix — the
ACMEinACME-42. Two to six uppercase letters or digits, filled in from the name. - Access mode — who may sign in. See below.
- Default visibility — what a new request is visible to.
- Select Create portal.
The portal answers at its address immediately, with no request types. It cannot accept a submission until one request type has a destination, so that is the next screen.
Access mode
Section titled “Access mode”| Mode | Who can sign in |
|---|---|
| Invite only | Only people a member invited. Nobody else can create an account, even with the address. |
| Domain allowlist | Anyone whose verified email address is at a domain you listed. |
| Open | Anyone with an email address. First submissions go to the hold queue. |
Change it at any time in the portal’s Settings. Changing to a narrower mode does not sign existing customers out; remove them individually if that is what you meant.
Default visibility
Section titled “Default visibility”Default visibility is what a new request is set to. A manager or a member can change any individual request afterwards.
| Value | Who sees the request |
|---|---|
| Private | The requester and the workspace |
| Company | Everyone in the requester’s company |
| Public | Everyone signed into the portal |
See Visibility.
The portal’s tabs
Section titled “The portal’s tabs”Requests, Request types, Companies, Customers, Hold queue, Branding, Settings. Managing a portal is admin-scoped: a member can see requests and reply, and cannot change the portal’s configuration.
Deleting a portal
Section titled “Deleting a portal”Settings → Delete portal. It deletes the portal, its customers, its companies and its request records. It does not change a single issue in GitHub: the issues stay open, with their comments, in the repositories they were created in.