git.iko.soy/crush
on main help sign in
docs(readme): document how to disable providers auto-update
04b5710Andrey Nering
README.md+43
compare with main
unifiedsplit
@@ -470,6 +470,49 @@ config:
470}
470}
471```
471```
472
472
473+## Disabling providers auto-update
474+
475+Crush automatically fetches the updated list of providers and models from
476+[Catwalk](https://github.com/charmbracelet/catwalk). We know some environments
477+have restricted internet access, so if you need to disable this you have two
478+options:
479+
480+Set `disable_provider_auto_update` into your `crush.json` config:
481+
482+```json
483+{
484+ "$schema": "https://charm.land/crush.json",
485+ "options": {
486+ "disable_provider_auto_update": true
487+ }
488+}
489+```
490+
491+Or alternatively set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment
492+variable:
493+
494+```bash
495+export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
496+```
497+
498+With that set, you'll have to manually update providers from time to time. It's
499+possible to do that with the `crush update-providers` command:
500+
501+```bash
502+# Update providers remotely from Catwalk.
503+crush update-providers
504+
505+# Update providers from a custom Catwalk base URL.
506+crush update-providers https://example.com/
507+
508+# Update providers from a local file.
509+crush update-providers /path/to/local-providers.json
510+
511+# Update providers from the embedded version.
512+# (Crush ships with an embedded copy of Catwalk on the time of the release).
513+crush update-providers embedded
514+```
515+
473## Whatcha think?
516## Whatcha think?
474
517
475We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
518We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on: