Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pkarolyi committed Apr 28, 2024
1 parent f43da9b commit 1c97f94
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# Garden Snail

Garden Snail is a self-hosted [Remote Cache](https://turbo.build/repo/docs/core-concepts/remote-caching#self-hosting) server for [Turborepo](https://turbo.build/repo) written in [NestJS](https://nestjs.com/).

## Getting started

The easiest way to get started is to use the published [Docker image](https://hub.docker.com/r/pkarolyi/garden-snail). It runs the remote cache server listening on port 3000. Currently only filesystem storage is available for the blobs and they are saved to `/garden-snail/blobs` in the container.

```sh
docker run -v "$(pwd)"/blobs:/garden-snail/blobs -p 3000:3000 pkarolyi/garden-snail
```

You can also build and run the application yourself, you will need NodeJS `^20.12` and pnpm `^9.0`:

```sh
pnpm install
pnpm build
node dist/main
```

## Notes

The `1.0.0` release is working and is compatible with the latest turborepo release (`1.12.4` tested).

This version **does not include any authorization or rate limiting functionality**. It is intended for internal deployments in organizations with external access controls.

## Roadmap

These are the things I will be working on in the coming weeks in no particular order:

- Authorization
- Rate limiting
- More providers
- S3

0 comments on commit 1c97f94

Please sign in to comment.