# GitHub Actions Cache Server

> Self-hosted GitHub Actions cache server written in Rust. Drop-in replacement for the GitHub cache backend: actions/cache, setup-* caches and BuildKit type=gha work unchanged on self-hosted runners.

Easily deploy your own GitHub actions cache without needing to change any workflow files

## Table of Contents

### Guide

- [Getting Started](https://gha-cache-server.falcondev.io/getting-started.md): Deploy the self-hosted GitHub Actions cache server with Docker Compose or Kubernetes. Point your self-hosted runners at it and actions/cache works unchanged.
- [How it works](https://gha-cache-server.falcondev.io/how-it-works.md): How the GitHub Actions Cache Server stands in for GitHub's cache backend on self-hosted runners, so actions/cache, setup-* caches and BuildKit type=gha need no workflow changes.
- [Metrics](https://gha-cache-server.falcondev.io/metrics.md): Prometheus metrics for the self-hosted GitHub Actions cache server: cache hits and misses, uploads and storage size.

### Storage Drivers

- [S3 / RustFS / MinIO / R2](https://gha-cache-server.falcondev.io/storage-drivers/s3.md): Store self-hosted GitHub Actions caches in AWS S3, RustFS, MinIO, Cloudflare R2 or any S3 compatible storage, with optional direct downloads from the bucket.
- [File System](https://gha-cache-server.falcondev.io/storage-drivers/file-system.md): Store self-hosted GitHub Actions caches on local disk. The default storage driver, no external service needed.
- [Google Cloud Storage](https://gha-cache-server.falcondev.io/storage-drivers/google-cloud-storage.md): Store self-hosted GitHub Actions caches in a Google Cloud Storage bucket, with optional direct downloads from the bucket.
- [Azure Blob Storage](https://gha-cache-server.falcondev.io/storage-drivers/azure-blob-storage.md): Store self-hosted GitHub Actions caches in Azure Blob Storage, authenticated by connection string or Entra ID.

### Database Drivers

- [PostgreSQL](https://gha-cache-server.falcondev.io/database-drivers/postgres.md): Use PostgreSQL as the database of the self-hosted GitHub Actions cache server. Recommended for production.
- [MySQL](https://gha-cache-server.falcondev.io/database-drivers/mysql.md): Use MySQL as the database of the self-hosted GitHub Actions cache server. Recommended for production.
- [SQLite](https://gha-cache-server.falcondev.io/database-drivers/sqlite.md): Use SQLite as the database of the self-hosted GitHub Actions cache server. The default, no extra service needed.

### Other

- [Database Drivers](https://gha-cache-server.falcondev.io/database-drivers.md): Database backends for the self-hosted GitHub Actions cache server: SQLite, PostgreSQL and MySQL.
- [Storage Drivers](https://gha-cache-server.falcondev.io/storage-drivers.md): Storage backends for the self-hosted GitHub Actions cache server: filesystem, S3 (RustFS, MinIO, R2), Google Cloud Storage and Azure Blob Storage.