turborepo-s3-remote-cache

command module

v0.3.0 Latest Latest Go to latest Published: Jan 12, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

HTTP server to store Turborepo remote cache to an AWS S3 bucket.

⚠ Do not use in production ⚠

Environment variable	Description
`TURBOREPO_ALLOWED_TOKENS`	Required. Allowed tokens for Turborepo authentication. Comma separated list
`AWS_REGION`	Required. Region of the S3 Bucket
`AWS_ACCESS_KEY_ID`	Required. Access key ID
`AWS_SECRET_ACCESS_KEY`	Required. Secret access key
`AWS_ENDPOINT`	Leave empty for default AWS endpoint. Customize for S3 compatible storage (e.g. min.io)
`AWS_DISABLE_SSL`	Disable SSL in the AWS SDK
`AWS_S3_BUCKET`	Default: `turborepo-cache`
`AWS_S3_FORCE_PATH_STYLE`	Use legacy path for S3 objects
`GIN_TRUSTED_PROXIES`	See Gin docs for more info. Comma separated list

For more info take a look at the AWS guide on configuring the SDK

docker run ghcr.io/acifani/turborepo-s3-remote-cache:latest

Check out all available tags in the Packages page.

Download a binary from the Release page, unpackage it and run it.

Binaries are available for Windows, MacOS, Linux in amd64 and arm64

git clone https://github.com/acifani/turborepo-s3-remote-cache.git
cd turborepo-s3-remote-cache
go build ./...
./turborepo-s3-remote-cache

You will need to configure the API endpoint and the auth token.

E.g.

turbo run build --api="http://localhost:8080" --token="t0k3n" --team="my-team"

If you provide a team name (recommended), the cache will be stored in a dedicated directory within the bucket.

There is no documentation for this package.

Path	Synopsis
config