Plugin management#
Disabled plugins#
The Buf Schema Registry (BSR) allows admins to manage which plugins are available to their users. When a plugin is disabled it's completely hidden and inaccessible. It will not be discoverable and cannot be used in Generated SDKs or remote plugins.
To disable a plugin, go to the Plugin management page in your admin panel at https://buf.build/admin/plugin-management
.
Within the Disabled plugins section, use the search bar to find the plugin you wish to disable and select it to add it to the disabled plugins list.
The panel shows which plugins have already been disabled.
To remove a plugin from the list of disabled plugins, click the – sign at the right of its row.
Recommended SDKs#
BSR admins can recommend SDKs for specific repositories, organizations, or globally. Recommended SDKs are eagerly generated, so they're always up to date with the repository's latest commit on the default label. If generation fails, the BSR displays a warning to consumers, allowing them to easily copy and share the SDK link with admins to help get the issue fixed.
This guide shows admins at each level (BSR instance, organization, and repository) how to set up recommended SDKs. The admin panel is the same for each, but is found in different areas of the BSR, depending on the level:
-
BSR instance admin
Go to the Plugin management page in your admin panel at
https://buf.build/admin/plugin-management
, there is a Recommended SDKs menu on this page. -
Organization admin
Go to the organization settings page at
https://buf.build/ORGANIZATION/settings/general
and scroll down to the Recommended SDKs section. -
Repository admin
Go to the repository settings page at
https://buf.build/ORGANIZATION/REPOSITORY/settings
and scroll down to the Recommended SDKs section.
You can use the search bar to find the plugin you want to use in a recommended SDK. To add a plugin, click the + sign at the right of its row. The panel shows which SDKs have been recommended at the current admin level and higher.
To remove a plugin from the recommended list, click the – sign at the right of its row. You can only remove plugins set at the admin level you're currently on.
Recommended SDK hierarchy#
Recommended SDKs exist at each admin level independently and don't interact with each other:
- When you recommend a plugin at the repository level, it's only recommended for that repository.
- If the same plugin is recommended at a higher level, it's recommended for all repositories under that level.
- If the plugin is then removed from recommended at the higher level, the repository level recommendation still exists.