aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/usage/secrets.en-us.md
diff options
context:
space:
mode:
authorLunny Xiao <xiaolunwen@gmail.com>2023-03-23 23:18:24 +0800
committerGitHub <noreply@github.com>2023-03-23 23:18:24 +0800
commite8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9 (patch)
treede72ccf6dda7170f4d8cbd3338294ba4b0ae2ecd /docs/content/doc/usage/secrets.en-us.md
parentdf411819ebe4d3e6852997ce41fadf837d5d4ea0 (diff)
downloadgitea-e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9.tar.gz
gitea-e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9.zip
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629)
- **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
Diffstat (limited to 'docs/content/doc/usage/secrets.en-us.md')
-rw-r--r--docs/content/doc/usage/secrets.en-us.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/content/doc/usage/secrets.en-us.md b/docs/content/doc/usage/secrets.en-us.md
new file mode 100644
index 0000000000..341ccbae12
--- /dev/null
+++ b/docs/content/doc/usage/secrets.en-us.md
@@ -0,0 +1,36 @@
+---
+date: "2022-12-19T21:26:00+08:00"
+title: "Secrets"
+slug: "usage/secrets"
+draft: false
+toc: false
+menu:
+ sidebar:
+ parent: "usage"
+ name: "Secrets"
+ weight: 1
+ identifier: "usage-secrets"
+---
+
+# Secrets
+
+Secrets allow you to store sensitive information in your user, organization or repository.
+Secrets are available on Gitea 1.19+.
+
+# Naming your secrets
+
+The following rules apply to secret names:
+
+- Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed.
+
+- Secret names must not start with the `GITHUB_` and `GITEA_` prefix.
+
+- Secret names must not start with a number.
+
+- Secret names are not case-sensitive.
+
+- Secret names must be unique at the level they are created at.
+
+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.