Monitor a Starport site through read-only connections
Overview
Section titled “Overview”Connect your hosting provider and analytics tool to Promptless so it can monitor your Starport site. Each connection is read-only: Promptless polls it for status or analytics and never writes to it. Set up a connection when you want Promptless to see what readers experience on the published site:
| Connection | What Promptless reads | What it learns |
|---|---|---|
| Vercel or Cloudflare Pages | Deployment status | Whether your docs site built and published. |
| PostHog | Page views and search queries on your docs | Which pages need work. |
You set up each connection once for your organization, not per site. For the full capability list, see What’s included in Starport.
Before you start
Section titled “Before you start”- An admin role in your Promptless organization, to use the integrations page.
- For Cloudflare Pages, permission in Cloudflare to create an API token for the account that hosts your docs site.
- For PostHog, permission to create a personal API key, and the project that receives your docs site’s events.
Connect Vercel
Section titled “Connect Vercel”With Vercel connected, Promptless reads your deployment status, so it can tell whether your docs site built and published. It never deploys, and it never changes your projects, domains, or environment variables.
An organization admin connects Vercel once, through OAuth, for the whole organization.
-
On the Promptless Integrations page, select Connect Vercel.
-
On Vercel, approve read-only access for Promptless.
-
On the Integrations page, confirm that Vercel shows as connected.
Connect Cloudflare Pages
Section titled “Connect Cloudflare Pages”With Cloudflare Pages connected, Promptless reads your Pages project and deployment status, so it can tell whether your docs site built. It never triggers a build, and it never changes anything in your account.
-
In Cloudflare, under My Profile > API Tokens, create a token with read access to Cloudflare Pages and Account Settings.
-
On the Promptless integrations page, select Connect Cloudflare.
-
In API Token, paste the token, then select Connect.
-
If the token reaches more than one Cloudflare account, choose the account that hosts your docs site, then select Use this account. Promptless reads deployment status from that account only.
Connect PostHog
Section titled “Connect PostHog”With PostHog connected, Promptless queries page views and search queries on your docs, so it can tell which pages need work. It never sends events, and it never changes anything in PostHog.
-
In PostHog, under Settings > Personal API keys, create a key with read access to Query and Project.
-
On the Promptless integrations page, select Connect PostHog.
-
In Personal API key, enter the key.
-
In Project ID, enter your project’s numeric ID. Find it under Settings > Project in PostHog, or in the project URL.
-
In Region, select US Cloud, EU Cloud, or Self-hosted. For a self-hosted instance, enter its URL.
-
Select Connect.
This read-only connection is separate from the analytics your Starport site reports on its own. For how that reporting works, see Starport analytics.
Manage a connection
Section titled “Manage a connection”To remove a connection, use the disconnect action on its card on the integrations page. You can remove one at any time, and Promptless stops reading from it. To check whether a connection is active, see Connection health.
See also
Section titled “See also”- Starport analytics, for the events your site reports and how to forward them to your analytics provider.
- Configure deploy settings, for the credentials your CI uses to publish the site.
- Vercel integration, for details of the Vercel connection.