2022-03-30 16:42:47 +08:00
---
date: "2021-07-20T00:00:00+00:00"
2023-05-24 14:21:39 +08:00
title: "NuGet Package Registry"
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
slug: "nuget"
2023-07-26 12:53:13 +08:00
sidebar_position: 80
2022-03-30 16:42:47 +08:00
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "NuGet"
2023-07-26 12:53:13 +08:00
sidebar_position: 80
2022-03-30 16:42:47 +08:00
identifier: "nuget"
---
2023-05-24 14:21:39 +08:00
# NuGet Package Registry
2022-03-30 16:42:47 +08:00
2022-10-13 18:19:39 +08:00
Publish [NuGet ](https://www.nuget.org/ ) packages for your user or organization. The package registry supports the V2 and V3 API protocol and you can work with [NuGet Symbol Packages ](https://docs.microsoft.com/en-us/nuget/create-packages/symbol-packages-snupkg ) too.
2022-03-30 16:42:47 +08:00
## Requirements
To work with the NuGet package registry, you can use command-line interface tools as well as NuGet features in various IDEs like Visual Studio.
Fix various typos (#20338)
* Fix various typos
Found via `codespell -q 3 -S ./options/locale,./options/license,./public/vendor -L actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon`
Co-authored-by: zeripath <art27@cantab.net>
2022-07-13 05:32:37 +08:00
More information about NuGet clients can be found in [the official documentation ](https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools ).
2022-03-30 16:42:47 +08:00
The following examples use the `dotnet nuget` tool.
## Configuring the package registry
To register the package registry you need to configure a new NuGet feed source:
```shell
dotnet nuget add source --name {source_name} --username {username} --password {password} https://gitea.example.com/api/packages/{owner}/nuget/index.json
```
| Parameter | Description |
| ------------- | ----------- |
| `source_name` | The desired source name. |
| `username` | Your Gitea username. |
2023-07-26 12:53:13 +08:00
| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token ](development/api-usage.md#authentication ) instead of the password. |
2022-03-30 16:42:47 +08:00
| `owner` | The owner of the package. |
For example:
```shell
dotnet nuget add source --name gitea --username testuser --password password123 https://gitea.example.com/api/packages/testuser/nuget/index.json
```
2023-07-26 12:53:13 +08:00
You can add the source without credentials and use the [`--api-key` ](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-push ) parameter when publishing packages. In this case you need to provide a [personal access token ](development/api-usage.md#authentication ).
2022-08-09 22:36:49 +08:00
2022-03-30 16:42:47 +08:00
## Publish a package
Publish a package by running the following command:
```shell
dotnet nuget push --source {source_name} {package_file}
```
| Parameter | Description |
| -------------- | ----------- |
| `source_name` | The desired source name. |
| `package_file` | Path to the package `.nupkg` file. |
For example:
```shell
dotnet nuget push --source gitea test_package.1.0.0.nupkg
```
You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.
### Symbol Packages
The NuGet package registry has build support for a symbol server. The PDB files embedded in a symbol package (`.snupkg`) can get requested by clients.
To do so, register the NuGet package registry as symbol source:
```
https://gitea.example.com/api/packages/{owner}/nuget/symbols
```
| Parameter | Description |
| --------- | ----------- |
| `owner` | The owner of the package registry. |
For example:
```
https://gitea.example.com/api/packages/testuser/nuget/symbols
```
## Install a package
To install a NuGet package from the package registry, execute the following command:
```shell
dotnet add package --source {source_name} --version {package_version} {package_name}
```
| Parameter | Description |
| ----------------- | ----------- |
| `source_name` | The desired source name. |
| `package_name` | The package name. |
| `package_version` | The package version. |
For example:
```shell
dotnet add package --source gitea --version 1.0.0 test_package
```
## Supported commands
```
dotnet add
dotnet nuget push
dotnet nuget delete
```