2023-02-26 18:08:07 -05:00
---
title: 'Vagrant Packages Repository'
2023-03-03 01:44:11 -05:00
license: 'Apache-2.0'
2023-10-08 09:11:22 -04:00
origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/vagrant.en-us.md'
2023-02-26 18:08:07 -05:00
---
Publish [Vagrant ](https://www.vagrantup.com/ ) packages for your user or organization.
## Requirements
To work with the Vagrant package registry, you need [Vagrant ](https://www.vagrantup.com/downloads ) 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
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| ----------------- | -------------------------------------------------------------------------------- |
| `owner` | The owner of the package. |
| `package_name` | The package name. |
| `package_version` | The package version, semver compatible. |
2023-02-26 18:08:07 -05:00
| `provider` | One of the [supported provider names ](https://www.vagrantup.com/docs/providers ). |
Example for uploading a Hyper-V box:
```shell
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
```
You cannot publish a box if a box of the same name, version and provider already exists. You must delete the existing package first.
## Install a package
To install a box from the package registry, execute the following command:
```shell
vagrant box add "https://forgejo.example.com/api/packages/{owner}/vagrant/{package_name}"
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| -------------- | ------------------------- |
2023-02-26 18:08:07 -05:00
| `owner` | The owner of the package. |
2023-03-03 01:44:11 -05:00
| `package_name` | The package name. |
2023-02-26 18:08:07 -05:00
For example:
```shell
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.
2023-08-19 11:14:45 -04:00
If the registry is private you can pass your [personal access token ](../../api-usage/#authentication ) in the `VAGRANT_CLOUD_TOKEN` environment variable.
2023-02-26 18:08:07 -05:00
## Supported commands
```
vagrant box add
```