# Chinmina

> GitHub App token vending machine for Buildkite pipelines.

## Introduction

- [Introduction](https://docs.chinmina.dev/introduction.md): The what and why of Chinmina Bridge

## Guides

- [Getting started](https://docs.chinmina.dev/guides/getting-started.md): What you need to prepare to get Chinmina going.
- [Buildkite integration](https://docs.chinmina.dev/guides/buildkite-integration.md): How to configure Buildkite to use Chinmina
- [Customizing token permissions](https://docs.chinmina.dev/guides/customizing-permissions.md): Grant elevated permissions or access additional repositories from Buildkite pipelines.
- [Protecting the GitHub private key](https://docs.chinmina.dev/guides/kms.md): Keep your GitHub app private key safe from compromise via AWS KMS.
- [Distributed cache](https://docs.chinmina.dev/guides/distributed-cache.md): Configure a shared Valkey cache with IAM authentication and encrypted token storage using AWS KMS and Tink.
- [Observability](https://docs.chinmina.dev/guides/observability.md): Using OpenTelemetry and logging to understand and diagnose Chinmina.
- [Deployment example](https://docs.chinmina.dev/guides/deployment-example.md): An example Chinmina infrastructure deployment on AWS
- [Verifying a release binary](https://docs.chinmina.dev/guides/verifying-releases.md): Verify Chinmina release binaries with cosign

## Reference

- [Configuration](https://docs.chinmina.dev/reference/configuration.md): Details of all configuration options available.
- [Git credentials format](https://docs.chinmina.dev/reference/git-credentials-format.md): Reference documentation for Git's credential helper protocol format.
- [Auditing](https://docs.chinmina.dev/reference/auditing.md): Audit log format, fields, and examples.
- [Telemetry](https://docs.chinmina.dev/reference/telemetry.md): OpenTelemetry traces and metrics reference.
- [Traces](https://docs.chinmina.dev/reference/telemetry/traces.md): Distributed trace span types, attributes, and relationships.
- [Metrics](https://docs.chinmina.dev/reference/telemetry/metrics.md): OpenTelemetry metrics, types, units, and attributes.
- [Profiles](https://docs.chinmina.dev/reference/profiles.md): Reference documentation for profile configuration.
- [Pipeline profiles](https://docs.chinmina.dev/reference/profiles/pipeline.md): Configure permissions for tokens scoped to pipeline repositories.
- [Organization profiles](https://docs.chinmina.dev/reference/profiles/organization.md): Details of what an organization profile is and how it is used.
- [Profile matching](https://docs.chinmina.dev/reference/profiles/matching.md): Control which pipelines can use profiles with claim-based access rules.
- [GET /healthcheck](https://docs.chinmina.dev/reference/api/health-check-and-status.md): Health check endpoint for monitoring Chinmina Bridge service availability.
- [POST /git-credentials/{profile}](https://docs.chinmina.dev/reference/api/pipeline-git-credentials.md): Git credential helper endpoint that returns GitHub tokens in Git credential format.
- [POST /token/{profile}](https://docs.chinmina.dev/reference/api/pipeline-token.md): API reference for the token vending endpoint that returns short-lived GitHub installation tokens.
- [POST /organization/git-credentials/{profile}](https://docs.chinmina.dev/reference/api/organization-git-credentials.md): Profile-scoped Git credential helper endpoint that returns GitHub tokens for a specific organization profile.
- [POST /organization/token/{profile}](https://docs.chinmina.dev/reference/api/organization-token.md): Profile-scoped token endpoint that returns GitHub tokens with profile-specific permissions.

## Contributing

- [Contribution guide](https://docs.chinmina.dev/contributing.md): Guidelines for contributing to the Chinmina project.
- [Local development](https://docs.chinmina.dev/contributing/development.md): Setting up a local development environment so you can contribute to Chinmina.
- [Release process](https://docs.chinmina.dev/contributing/releases.md): How releases of Chinmina are considered ready, and how they're created.