Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pkarolyi committed May 4, 2024
1 parent 8376c9a commit b472e91
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ Garden Snail is a self-hosted [Remote Cache](https://turbo.build/repo/docs/core-

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.

```sh
docker run -e STORAGE_PROVIDER=local -e LOCAL_STORAGE_PATH=/blobs -v "$(pwd)"/blobs:/blobs -p 3000:3000 pkarolyi/garden-snail
```

You can also build and run the application yourself, you will need NodeJS `20.12.2` and pnpm `9.0.6`:

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

### Environment variables

```sh
Expand All @@ -27,18 +39,6 @@ S3_FORCE_PATH_STYLE=
S3_ENDPOINT=
```

```sh
docker run -e STORAGE_PROVIDER=local -e LOCAL_STORAGE_PATH=/blobs -v "$(pwd)"/blobs:/blobs -p 3000:3000 pkarolyi/garden-snail
```

You can also build and run the application yourself, you will need NodeJS `20.12.2` and pnpm `9.0.6`:

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

## Notes

The `1.1.0` release is working and is compatible with the latest turborepo releases. Check the integration tests on the latest [workflow run](https://github.com/pkarolyi/garden-snail/actions/).
Expand Down

0 comments on commit b472e91

Please sign in to comment.