mirror of
https://github.com/go-gitea/gitea
synced 2024-12-29 13:14:25 +01:00
bd4c7ce578
This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
---
|
|
date: "2023-05-10T00:00:00+00:00"
|
|
title: "Go Package Registry"
|
|
slug: "go"
|
|
sidebar_position: 45
|
|
draft: false
|
|
toc: false
|
|
menu:
|
|
sidebar:
|
|
parent: "packages"
|
|
name: "Go"
|
|
sidebar_position: 45
|
|
identifier: "go"
|
|
---
|
|
|
|
# Go Package Registry
|
|
|
|
Publish Go packages for your user or organization.
|
|
|
|
## Publish a package
|
|
|
|
To publish a Go package perform a HTTP `PUT` operation with the package content in the request body.
|
|
You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.
|
|
The package must follow the [documented structure](https://go.dev/ref/mod#zip-files).
|
|
|
|
```
|
|
PUT https://gitea.example.com/api/packages/{owner}/go/upload
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| --------- | ----------- |
|
|
| `owner` | The owner of the package. |
|
|
|
|
To authenticate to the package registry, you need to provide [custom HTTP headers or use HTTP Basic authentication](development/api-usage.md#authentication):
|
|
|
|
```shell
|
|
curl --user your_username:your_password_or_token \
|
|
--upload-file path/to/file.zip \
|
|
https://gitea.example.com/api/packages/testuser/go/upload
|
|
```
|
|
|
|
If you are using 2FA or OAuth use a [personal access token](development/api-usage.md#authentication) instead of the password.
|
|
|
|
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 name exist already. |
|
|
|
|
## Install a package
|
|
|
|
To install a Go package instruct Go to use the package registry as proxy:
|
|
|
|
```shell
|
|
# use latest version
|
|
GOPROXY=https://gitea.example.com/api/packages/{owner}/go go install {package_name}
|
|
# or
|
|
GOPROXY=https://gitea.example.com/api/packages/{owner}/go go install {package_name}@latest
|
|
# use specific version
|
|
GOPROXY=https://gitea.example.com/api/packages/{owner}/go go install {package_name}@{package_version}
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| ----------------- | ----------- |
|
|
| `owner` | The owner of the package. |
|
|
| `package_name` | The package name. |
|
|
| `package_version` | The package version. |
|
|
|
|
If the owner of the packages is private you need to [provide credentials](https://go.dev/ref/mod#private-module-proxy-auth).
|
|
|
|
More information about the `GOPROXY` environment variable and how to protect against data leaks can be found in [the documentation](https://go.dev/ref/mod#private-modules).
|