Host a scoped registry for your organization
Host a scoped registry as a way to distribute custom packages to members of your organization.
Read time 2 minutesLast updated 22 days ago
As a custom package provider, you can host a scoped registry, so the location of your registry is available within Package Manager.
Supported use cases and complying with Terms of Service
The intended scenario for scoped registries is to distribute custom packages within your organization, so your organization members can easily access packages (or collections of packages) within Package Manager.
Important
As a scoped registry provider, make sure any package registry servers you set up conform to Unity's Terms of Service and Unity's Package Guiding Principles & Guidelines.
Unity provides access to the Package Manager to facilitate sharing knowledge and creations, but not as a marketplace, store, or platform.
Don't use the Unity Editor to promote, advertise, or distribute your Packages, products, or services to members outside of your organization.
Supported registry types
Hosting tools aren't provided by Unity, but the Package Manager supports registries based on the npm protocol.
Important
When you set up your own package registry server:
- Make sure that whatever registry server you choose implements the or
/-/v1/searchendpoints. If you experience issues using the/-/allorsearchendpoints of the registry, contact the registry provider and make sure they support the npm protocol.all - Make sure you use only those features that are compatible with Unity's scoped registries. For example, Unity doesn't support namespaces that use the notation that npm supports.
@scope
Control access to your scoped registry
If you want full control over who accesses packages in your scoped registry, you can enable npm authentication for specific users. Package consumers can then configure Scoped registry authentication to use their authentication tokens.
npm