git diff abe8fe352711601fbcd24bf4505f7e0b81a93c5d..d3982bcd814bac93e3cbce1c7eb749b17e413fbd -- $(find . -type f -name '*en-us*')
3 KiB
title | license | origin_url |
---|---|---|
Vagrant Packages Repository | Apache-2.0 | d3982bcd81/docs/content/usage/packages/vagrant.en-us.md |
Publish Vagrant packages for your user or organization.
Requirements
To work with the Vagrant package registry, you need Vagrant and a tool to make HTTP requests like curl
.
Publish a package
Publish a Vagrant box by performing a HTTP PUT request to the registry:
PUT https://forgejo.example.com/api/packages/{owner}/vagrant/{package_name}/{package_version}/{provider}.box
Parameter | Description |
---|---|
owner |
The owner of the package. |
package_name |
The package name. |
package_version |
The package version, semver compatible. |
provider |
One of the supported provider names. |
Example for uploading a Hyper-V box:
curl --user your_username:your_password_or_token \
--upload-file path/to/your/vagrant.box \
https://forgejo.example.com/api/packages/testuser/vagrant/test_system/1.0.0/hyperv.box
If you are using 2FA or OAuth use a personal access token instead of the password.
You cannot publish a box if a box of the same name, version and provider already exists. You must delete the existing package first.
The server responds with the following HTTP Status codes.
HTTP Status Code | Meaning |
---|---|
201 Created |
The package has been published. |
400 Bad Request |
The package is invalid. |
409 Conflict |
A package with the same combination of parameters exists already. |
Install a package
To install a box from the package registry, execute the following command:
vagrant box add "https://forgejo.example.com/api/packages/{owner}/vagrant/{package_name}"
Parameter | Description |
---|---|
owner |
The owner of the package. |
package_name |
The package name. |
For example:
vagrant box add "https://forgejo.example.com/api/packages/testuser/vagrant/test_system"
This will install the latest version of the package. To add a specific version, use the --box-version
parameter.
If the registry is private you can pass your personal access token in the VAGRANT_CLOUD_TOKEN
environment variable.
Supported commands
vagrant box add