Deploy Nx Custom Cache on Railway

Nx Remote Cache Server (Deno + S3)

This template provides a self-hosted Nx remote cache server, built with Deno and using Amazon S3 (or compatible) as the backend. It follows the official Nx Custom Remote Cache specification and offers a fast and secure caching layer for distributed builds.

✨ Features

Fully compatible with Nx Custom Remote Cache API
Amazon S3-compatible storage support (e.g. MinIO)
Secure access via Bearer token
Streaming file uploads/downloads for performance
Docker image available for easy deployment

🧬 Environment Variables

Variable	Description
`AWS_REGION`	AWS region
`AWS_ACCESS_KEY_ID`	AWS access key
`AWS_SECRET_ACCESS_KEY`	AWS secret key
`S3_BUCKET_NAME`	Bucket name
`S3_ENDPOINT_URL`	S3-compatible endpoint
`NX_CACHE_ACCESS_TOKEN`	Shared secret token for auth
`PORT` (optional)	Port to run the server (default 3000)

🚀 Quick Start (Railway CLI)

Click "Deploy" or use Railway CLI.
Set your environment variables (see above).
The app will start and listen on the specified port (default: 3000).

📚 Usage with Nx

Set these in your Nx workspace:

NX_SELF_HOSTED_REMOTE_CACHE_SERVER=https://your-deployment.up.railway.app
NX_SELF_HOSTED_REMOTE_CACHE_ACCESS_TOKEN=your-secure-token

✍️ Author

Igor Katsuba

📄 License

MIT