2022-12-20 04:07:13 -05:00
---
date: "2022-12-19T21:26:00+08:00"
2023-02-01 07:53:04 -05:00
title: "Secrets"
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-27 22:33:41 -05:00
slug: "secrets"
2023-04-04 08:47:31 -05:00
weight: 50
2022-12-20 04:07:13 -05:00
draft: false
toc: false
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-27 22:33:41 -05:00
aliases:
- /en-us/secrets
2022-12-20 04:07:13 -05:00
menu:
sidebar:
2023-03-23 10:18:24 -05:00
parent: "usage"
name: "Secrets"
2023-04-04 08:47:31 -05:00
weight: 50
2023-03-23 10:18:24 -05:00
identifier: "usage-secrets"
2022-12-20 04:07:13 -05:00
---
2023-02-01 07:53:04 -05:00
# Secrets
2022-12-20 04:07:13 -05:00
2023-02-01 07:53:04 -05:00
Secrets allow you to store sensitive information in your user, organization or repository.
2022-12-20 04:07:13 -05:00
Secrets are available on Gitea 1.19+.
# Naming your secrets
The following rules apply to secret names:
2023-02-01 07:53:04 -05:00
- Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]` , `[0-9]` ) or underscores (`_`). Spaces are not allowed.
2022-12-20 04:07:13 -05:00
2023-02-01 07:53:04 -05:00
- Secret names must not start with the `GITHUB_` and `GITEA_` prefix.
2022-12-20 04:07:13 -05:00
2023-02-01 07:53:04 -05:00
- Secret names must not start with a number.
2022-12-20 04:07:13 -05:00
2023-02-01 07:53:04 -05:00
- Secret names are not case-sensitive.
2022-12-20 04:07:13 -05:00
2023-02-01 07:53:04 -05:00
- Secret names must be unique at the level they are created at.
2022-12-20 04:07:13 -05:00
For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level.
If a secret with the same name exists at multiple levels, the secret at the lowest level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.
