Migrate to your new registry
Buf Pro gives organizations complete control over their development environment through a private instance with a dedicated subdomain, providing an integrated and dependable developer experience. This reduces the amount of time spent on tedious and repetitive tasks, freeing up more time for developers to create value for their clients.
Our Pro tier gives organizations a private instance of the BSR with dedicated subdomain instead of the public instance at buf.build. When moving to your private instance, you'll need to complete a few basic tasks.
In order to access the BSR, you will need to provide login configuration details via the buf CLI.
$ buf registry login <name>.buf.dev
Bot users will need to have tokens from the new instance generated, see authentication for details.
Organizations on the Pro tier have 2 options for managing team members:
- Set up custom SSO via OAuth2 OIDC, or SAML. See the SSO docs for more information.
- Use the public BSR as your identity provider (IdP). Instructions below.
Using the BSR as your IdP
- New organization members must sign up for the BSR.
- The organization admin must then add the member to the org on the public BSR via the https://buf.build/[org]/members page.
- The new member can then log in to the private BSR instance. You can organize members into teams on the private instance by creating Organizations there.
Using community modules in your BSR server
Buf has made various modules available in the BSR for community use and regularly maintains them. These modules include
the popular googleapis and
protoc-gen-validate, which were added to support community
development with the BSR. We manage these modules for your private BSR server,
which alleviates the need to download and locally manage these Protobuf files, especially those from larger modules such
Syncing the modules can take a few hours from the time we create the server, and once they are present, you need to change any dependencies on the public BSR versions to point to your private instance. See the section below for instructions.
Rename modules and update dependencies
With your own dedicated instance of the Buf Schema Registry, you need to change the
name of all configured modules to
reference your private subdomain (
<name>.buf.dev). You also need to adjust any dependencies that refer to
to reference your private subdomain. Buf copies all of the managed modules to your
dedicated instance so you can start depending on them right away, but if you have dependencies across your own
modules, you need to push them to your new dedicated instance and update your
buf.yaml files so that no cross-domain
- Get a token from the BSR—see authentication for details
- Login to your new instance
$ buf registry login example.buf.dev
- Replace all occurrences of
buf.yamlfiles with your private subdomain.
- Push all of your modules
$ buf push