mirror of
https://gitea.com/gitea/docs.git
synced 2026-07-22 02:37:42 +00:00
Add Go package registry (#24687)
Fixes #7608 This PR adds a Go package registry usable with the Go proxy protocol. 
This commit is contained in:
@@ -1223,6 +1223,7 @@ Task queue configuration has been moved to `queue.task`. However, the below conf
|
|||||||
- `LIMIT_SIZE_CONTAINER`: **-1**: Maximum size of a Container upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
- `LIMIT_SIZE_CONTAINER`: **-1**: Maximum size of a Container upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
- `LIMIT_SIZE_DEBIAN`: **-1**: Maximum size of a Debian upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
- `LIMIT_SIZE_DEBIAN`: **-1**: Maximum size of a Debian upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
- `LIMIT_SIZE_GENERIC`: **-1**: Maximum size of a Generic upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
- `LIMIT_SIZE_GENERIC`: **-1**: Maximum size of a Generic upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
|
- `LIMIT_SIZE_GO`: **-1**: Maximum size of a Go upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
- `LIMIT_SIZE_HELM`: **-1**: Maximum size of a Helm upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
- `LIMIT_SIZE_HELM`: **-1**: Maximum size of a Helm upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
- `LIMIT_SIZE_MAVEN`: **-1**: Maximum size of a Maven upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
- `LIMIT_SIZE_MAVEN`: **-1**: Maximum size of a Maven upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
- `LIMIT_SIZE_NPM`: **-1**: Maximum size of a npm upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
- `LIMIT_SIZE_NPM`: **-1**: Maximum size of a npm upload (`-1` means no limits, format `1000`, `1 MB`, `1 GiB`)
|
||||||
|
|||||||
@@ -83,7 +83,7 @@ curl --user your_username:your_password_or_token \
|
|||||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||||
You cannot publish a file with the same name twice to a package. You must delete the existing package version first.
|
You cannot publish a file with the same name twice to a package. You must delete the existing package version first.
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
@@ -115,7 +115,7 @@ curl --user your_username:your_token_or_password -X DELETE \
|
|||||||
https://gitea.example.com/api/packages/testuser/debian/pools/bionic/main/test-package/1.0.0/amd64
|
https://gitea.example.com/api/packages/testuser/debian/pools/bionic/main/test-package/1.0.0/amd64
|
||||||
```
|
```
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ curl --user your_username:your_password_or_token \
|
|||||||
|
|
||||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
@@ -83,7 +83,7 @@ curl --user your_username:your_token_or_password \
|
|||||||
https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin
|
https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
@@ -111,7 +111,7 @@ curl --user your_username:your_token_or_password -X DELETE \
|
|||||||
https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0
|
https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0
|
||||||
```
|
```
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
@@ -140,7 +140,7 @@ curl --user your_username:your_token_or_password -X DELETE \
|
|||||||
https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin
|
https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
|
|||||||
77
doc/usage/packages/go.en-us.md
Normal file
77
doc/usage/packages/go.en-us.md
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-10T00:00:00+00:00"
|
||||||
|
title: "Go Packages Repository"
|
||||||
|
slug: "go"
|
||||||
|
weight: 45
|
||||||
|
draft: false
|
||||||
|
toc: false
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "packages"
|
||||||
|
name: "Go"
|
||||||
|
weight: 45
|
||||||
|
identifier: "go"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Go Packages Repository
|
||||||
|
|
||||||
|
Publish Go packages for your user or organization.
|
||||||
|
|
||||||
|
**Table of Contents**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
## 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]({{< relref "doc/development/api-usage.en-us.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]({{< relref "doc/development/api-usage.en-us.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).
|
||||||
@@ -69,7 +69,7 @@ curl --user your_username:your_password_or_token \
|
|||||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||||
You cannot publish a file with the same name twice to a package. You must delete the existing package version first.
|
You cannot publish a file with the same name twice to a package. You must delete the existing package version first.
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
@@ -99,7 +99,7 @@ curl --user your_username:your_token_or_password -X DELETE \
|
|||||||
https://gitea.example.com/api/packages/testuser/rpm/test-package/1.0.0/x86_64
|
https://gitea.example.com/api/packages/testuser/rpm/test-package/1.0.0/x86_64
|
||||||
```
|
```
|
||||||
|
|
||||||
The server reponds with the following HTTP Status codes.
|
The server responds with the following HTTP Status codes.
|
||||||
|
|
||||||
| HTTP Status Code | Meaning |
|
| HTTP Status Code | Meaning |
|
||||||
| ----------------- | ------- |
|
| ----------------- | ------- |
|
||||||
|
|||||||
Reference in New Issue
Block a user