Quick Start

1. Create an account

2. Create a package

Once logged in, navigate to Packages and click Create package. Follow the wizard steps and enter your package's details:

Name: The displayable name of your package (e.g. "Laravel Uploader").
Slug: The unique slug of your package (e.g. "laravel-uploader").
Description: A brief description of what your package does.
Repository: Connect to GitHub and enter the repository you wish to use.

3. Create a release

With your package created, add your first release. You can do this inside of GitHub by creating a new release.

Privato configures a webhook on your repository and will automatically sync the archive files into the Composer repository.

Be sure to tag your releases using semantic versioning (e.g., v1.0.0, v1.1.0) so that Composer can correctly understand which versions are available when installing.

4. Generate a license

Go to the Licenses tab inside of your package and click Create license.

Privato will automatically generate a license key for you, but you will need to enter an identifier (typically an email address).

5. Configure Composer

Your customer adds your registry to their composer.json:

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://my-team-slug.privato.pub/composer"
        }
    ]
}

Then authenticate with their license key:

composer config http-basic.my-team.privato.pub license LICENSE_KEY

6. Install the package

Now your customer can install your package like any other Composer package: