Skip to content

Commit

Permalink
[docs] add note about github plugin cache env-var (#2479)
Browse files Browse the repository at this point in the history
## Summary

## How was it tested?
  • Loading branch information
savil authored Jan 14, 2025
1 parent 0a0ecf5 commit c3cab01
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/app/docs/guides/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ Sometimes, you may want to share a plugin across multiple projects or users. In
]
```

Note that Devbox will cache Github plugins for 24 hours. This is to aid performance of `devbox shell` and similar commands, and avoids downloading the plugin from Github each time. In extenuating circumstances, you can bypass this cache by setting `export DEVBOX_X_GITHUB_PLUGIN_CACHE_TTL=<time>` , where time is a valid input to `time.ParseDuration` (see [doc](https://pkg.go.dev/time#ParseDuration)) such as "120s" or "2m".

## An Example of a Plugin: Nginx
Let's take a look at the plugin for Nginx. To get started, let's initialize a new devbox project, and add the `nginx` package:

Expand Down

0 comments on commit c3cab01

Please sign in to comment.