linden123/githaven-fork
1
1
Fork 0
forked from Shiloh/githaven
Code Pull Requests Activity
bb25f85ce8
githaven-fork/docs/content/doc/usage/packages/vagrant.en-us.md
John Olheiser bb25f85ce8
Refactor docs (#23752) 
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00

2.2 KiB
Raw Blame History

date title slug weight draft toc menu
2022-08-23T00:00:00+00:00 Vagrant Packages Repository vagrant 120 false false
sidebar
parent name weight identifier
packages Vagrant 120 vagrant

Vagrant Packages Repository

Publish Vagrant packages for your user or organization.

Table of Contents

{{< toc >}}

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://gitea.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://gitea.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:

vagrant box add "https://gitea.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://gitea.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]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) in the VAGRANT_CLOUD_TOKEN environment variable.

Supported commands

vagrant box add