gcportrait
Try the demo GitHub

Documentation

How to use the web app, run your own instance and script its diagrams through the API. Every guide here is a Markdown file in the docs folder of the repository, verified against the code it describes; the contributor material lives next to the code on GitHub.

Start

  • Getting started

    Try gcportrait in two minutes: the sign-in-free demo or a local demo build, what the diagram shows, and where to go next.

  • Modes

    The ways gcportrait reads Google Cloud: your own account, the instance’s service account, export files, and the synthetic demo.

  • Permissions

    What reading a scope needs: the permission matrix with copy-ready gcloud commands, the quota project, and the service-account grant.

Use

  • Lenses and filters

    The eleven lenses, focus views, filters, detail levels, drill-in and chips: how to narrow a large organisation to what matters.

  • Timeline

    Move any view through the last 35 days: daily ticks from Cloud Asset Inventory, the diff overlay, extra ticks from exports.

  • Export

    Save the current view as SVG, PNG (2× or 3×) or an editable draw.io file, whole diagram or viewport, and what the title block holds.

  • Sample exports

    Real SVG, PNG and draw.io exports of the demo organisations in light and dark, to download, open in the browser or in diagrams.net.

  • FAQ

    Answers on missing edges, unknown asset types, the 35-day limit, Shared VPC, the cost of Cloud Asset Inventory calls and privacy.

Run your own

  • Self-host

    Run gcportrait on Cloud Run in your own Google Cloud project: one installer line with your project id, the OAuth client, one redeploy.

  • Self-host options

    Every optional setting of a self-hosted instance: region, memory, IAP, service-account mode, demo-only, custom domain, legal pages, building from source.

  • Configuration

    Every setting of a gcportrait instance: the backend’s environment, the install.sh, deploy.sh and uninstall.sh flags, the image, compose.

  • API

    An instance’s HTTP API for scripts: SVG, PNG and draw.io renders of a scope, an export or a demo, live pulls, curl examples.