Skip to content

Commit c3cab01

Browse files
authored
[docs] add note about github plugin cache env-var (#2479)
## Summary ## How was it tested?
1 parent 0a0ecf5 commit c3cab01

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/app/docs/guides/plugins.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ Sometimes, you may want to share a plugin across multiple projects or users. In
5757
]
5858
```
5959

60+
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".
61+
6062
## An Example of a Plugin: Nginx
6163
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:
6264

0 commit comments

Comments
 (0)