ReviewPhin documentation

ReviewPhin is a self-hosted worker that reviews merge requests or pull requests and publishes results back to the code review platform. You deploy it once, connect a project, and trigger reviews from the places your team already works.

The docs are split into four areas. Pick the one that matches what you are trying to do.

The four areas

Area	For	Start here
Using ReviewPhin	Developers who comment on and read reviews	Using ReviewPhin
Management	Operators who register connections, tenants, and model profiles	Management
Deployment & instance management	Operators who run and expose the worker	Deployment
Development	Contributors and provider authors	Development

First run, end to end

New here? Follow this path once. Each step links to its canonical page, so nothing is repeated.

1. Deploy the worker. Run it locally, with Docker, or on Kubernetes.
2. Expose it publicly. Give the platform an HTTPS URL with a tunnel or ingress and set PUBLIC_URL.
3. Add a platform connection. Store reusable GitLab or GitHub credentials.
4. Add a tenant. Attach one project or repository to that connection.
5. Trigger the first review. Comment on a merge request or pull request.

Media placeholder — end-to-end setup walkthrough

Suggested clip (~90s): deploy with Docker Compose, open a tunnel, run platform connection add and tenant add, then trigger a first review on a real merge request. This is the highest-value recording for the whole site.

What ReviewPhin operates

ReviewPhin stores reusable platform credentials as a platform connection. A tenant attaches one project or repository to a connection. Review jobs are created from webhooks or manual triggers and processed by the review worker.

GitLab is the primary setup path today. GitHub is supported through a GitHub App registration flow. Custom platform and storage providers can be loaded at runtime.