Scoped registry authentication
Host a scoped registry for your organization
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.
ImportantAs 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
/-/v1/search
or /-/all
endpoints.
- 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
@scope
notation that npm
supports.
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 npm
authentication tokens.
Additional resources
Scoped registry authentication