Update meta data of docs

This commit is contained in:
Lunny Xiao
2024-08-06 16:44:42 -07:00
parent 4917bd18ae
commit af22422e1a
861 changed files with 1383 additions and 7148 deletions
@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Administration"
slug: "administration"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
name: "Administration"
@@ -1,18 +1,11 @@
---
date: "2019-12-28"
title: "Adding Legal Pages"
slug: adding-legal-pages
sidebar_position: 110
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Adding Legal Pages"
identifier: "adding-legal-pages"
sidebar_position: 110
---
# Adding Legal Pages
Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance.
## Getting Pages
@@ -1,16 +1,7 @@
---
date: "2017-01-01T16:00:00+02:00"
title: "Backup and Restore"
slug: "backup-and-restore"
sidebar_position: 11
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Backup and Restore"
sidebar_position: 11
identifier: "backup-and-restore"
---
# Backup and Restore
@@ -1,16 +1,7 @@
---
date: "2020-01-25T21:00:00-03:00"
title: "Embedded data extraction tool"
slug: "cmd-embedded"
sidebar_position: 20
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Embedded data extraction tool"
sidebar_position: 20
identifier: "cmd-embedded"
---
# Embedded data extraction tool
@@ -1,16 +1,7 @@
---
date: "2017-01-01T16:00:00+02:00"
title: "Command Line"
slug: "command-line"
sidebar_position: 1
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Command Line"
sidebar_position: 1
identifier: "command-line"
---
# Command Line
@@ -394,11 +385,11 @@ append it to `doctor.go`.
```go
var checklist = []check{
{
title: "Check if OpenSSH authorized_keys file id correct",
f: runDoctorLocationMoved,
},
// more checks please append here
{
title: "Check if OpenSSH authorized_keys file id correct",
f: runDoctorLocationMoved,
},
// more checks please append here
}
```
@@ -1,16 +1,10 @@
---
date: "2016-12-26T16:00:00+02:00"
title: "Config Cheat Sheet"
slug: "config-cheat-sheet"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Config Cheat Sheet"
sidebar_position: 30
identifier: "config-cheat-sheet"
---
# Configuration Cheat Sheet
@@ -1,16 +1,10 @@
---
date: "2017-04-15T14:56:00+02:00"
title: "Customizing Gitea"
slug: "customizing-gitea"
sidebar_position: 100
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Customizing Gitea"
identifier: "customizing-gitea"
sidebar_position: 100
---
# Customizing Gitea
@@ -1,16 +1,7 @@
---
date: "2019-10-15T10:10:00+05:00"
title: "Email setup"
slug: "email-setup"
sidebar_position: 12
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Email setup"
sidebar_position: 12
identifier: "email-setup"
---
# Email setup
@@ -1,16 +1,7 @@
---
date: "2017-04-08T11:34:00+02:00"
title: "Environment variables"
slug: "environment-variables"
sidebar_position: 10
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Environment variables"
sidebar_position: 10
identifier: "environment-variables"
---
# Environment variables
@@ -1,19 +1,10 @@
---
date: "2018-11-23:00:00+02:00"
title: "External renderers"
slug: "external-renderers"
sidebar_position: 60
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "External renderers"
sidebar_position: 60
identifier: "external-renderers"
---
# Custom files rendering configuration
# External renderers
Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries,
it is just a matter of:
@@ -1,19 +1,10 @@
---
date: "2018-05-11T11:00:00+02:00"
title: "Setup fail2ban"
slug: "fail2ban-setup"
sidebar_position: 16
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Fail2ban setup"
sidebar_position: 16
identifier: "fail2ban-setup"
---
# Fail2ban setup to block users after failed login attempts
# Fail2ban Setup
**Remember that fail2ban is powerful and can cause lots of issues if you do it incorrectly, so make
sure to test this before relying on it so you don't lock yourself out.**
@@ -1,19 +1,10 @@
---
date: "2019-10-06T08:00:00+05:00"
title: "Git LFS setup"
slug: "git-lfs-setup"
sidebar_position: 12
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Git LFS setup"
sidebar_position: 12
identifier: "git-lfs-setup"
---
# Git Large File Storage setup
# Git LFS setup
To use Gitea's built-in LFS support, you must update the `app.ini` file:
@@ -1,19 +1,12 @@
---
date: "2018-06-02T11:00:00+02:00"
title: "HTTPS setup"
slug: "https-setup"
sidebar_position: 12
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "HTTPS setup"
sidebar_position: 12
identifier: "https-setup"
---
# HTTPS setup to encrypt connections to Gitea
# HTTPS setup
## Using the built-in server
@@ -1,10 +1,9 @@
---
date: "2019-04-02T17:06:00+01:00"
title: "Logging Configuration"
slug: "logging-configuration"
sidebar_position: 40
toc: false
draft: false
menu:
sidebar:
parent: "administration"
@@ -1,16 +1,7 @@
---
date: "2019-10-23T17:00:00-03:00"
title: "Mail templates"
slug: "mail-templates"
sidebar_position: 45
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Mail templates"
sidebar_position: 45
identifier: "mail-templates"
---
# Mail templates
@@ -1,16 +1,7 @@
---
date: "2019-09-06T01:35:00-03:00"
title: "Repository indexer"
slug: "repo-indexer"
sidebar_position: 45
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Repository indexer"
sidebar_position: 45
identifier: "repo-indexer"
---
# Repository indexer
@@ -1,16 +1,7 @@
---
date: "2018-05-22T11:00:00+00:00"
title: "Reverse Proxies"
slug: "reverse-proxies"
sidebar_position: 16
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Reverse Proxies"
sidebar_position: 16
identifier: "reverse-proxies"
---
# Reverse Proxies
@@ -1,19 +1,12 @@
---
date: "2019-12-31T13:55:00+05:00"
title: "Search Engines Indexation"
slug: "search-engines-indexation"
sidebar_position: 60
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "Search Engines Indexation"
sidebar_position: 60
identifier: "search-engines-indexation"
---
# Search engines indexation of your Gitea installation
# Search Engines Indexation
By default your Gitea installation will be indexed by search engines.
If you don't want your repository to be visible for search engines read further.
@@ -1,16 +1,7 @@
---
date: "2019-08-17T10:20:00+01:00"
title: "GPG Commit Signatures"
slug: "signing"
sidebar_position: 50
toc: false
draft: false
menu:
sidebar:
parent: "administration"
name: "GPG Commit Signatures"
sidebar_position: 50
identifier: "signing"
---
# GPG Commit Signatures
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2021-01-22T00:00:00+02:00"
title: "Contributing"
slug: "contributing"
sidebar_position: 35
toc: false
draft: false
menu:
sidebar:
name: "Contributing"
@@ -1,16 +1,7 @@
---
date: "2021-11-01T23:41:00+08:00"
title: "Guidelines for Backend Development"
slug: "guidelines-backend"
sidebar_position: 20
toc: false
draft: false
menu:
sidebar:
parent: "contributing"
name: "Guidelines for Backend"
sidebar_position: 20
identifier: "guidelines-backend"
---
# Guidelines for Backend Development
@@ -1,16 +1,7 @@
---
date: "2021-10-13T16:00:00+02:00"
title: "Guidelines for Frontend Development"
slug: "guidelines-frontend"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
parent: "contributing"
name: "Guidelines for Frontend"
sidebar_position: 30
identifier: "guidelines-frontend"
---
# Guidelines for Frontend Development
@@ -1,16 +1,7 @@
---
date: "2023-02-14T00:00:00+00:00"
title: "Guidelines for Refactoring"
slug: "guidelines-refactoring"
sidebar_position: 40
toc: false
draft: false
menu:
sidebar:
parent: "contributing"
name: "Guidelines for Refactoring"
sidebar_position: 40
identifier: "guidelines-refactoring"
---
# Guidelines for Refactoring
@@ -1,16 +1,7 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Localization"
slug: "localization"
sidebar_position: 70
toc: false
draft: false
menu:
sidebar:
parent: "contributing"
name: "Localization"
sidebar_position: 70
identifier: "localization"
---
# Localization
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Development"
slug: "development"
sidebar_position: 40
toc: false
draft: false
menu:
sidebar:
name: "Development"
@@ -1,16 +1,7 @@
---
date: "2018-06-24:00:00+02:00"
title: "API Usage"
slug: "api-usage"
sidebar_position: 40
toc: false
draft: false
menu:
sidebar:
parent: "development"
name: "API Usage"
sidebar_position: 40
identifier: "api-usage"
---
# API Usage
@@ -1,16 +1,7 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Hacking on Gitea"
slug: "hacking-on-gitea"
sidebar_position: 10
toc: false
draft: false
menu:
sidebar:
parent: "development"
name: "Hacking on Gitea"
sidebar_position: 10
identifier: "hacking-on-gitea"
---
# Hacking on Gitea
@@ -1,16 +1,10 @@
---
date: "2019-04-15T17:29:00+08:00"
title: "Integrations"
slug: "integrations"
sidebar_position: 65
toc: false
draft: false
menu:
sidebar:
parent: "development"
name: "Integrations"
sidebar_position: 65
identifier: "integrations"
---
# Integrations
@@ -1,19 +1,10 @@
---
date: "2019-04-15T17:29:00+08:00"
title: "Migrations Interfaces"
slug: "migrations-interfaces"
sidebar_position: 55
toc: false
draft: false
menu:
sidebar:
parent: "development"
name: "Migrations Interfaces"
sidebar_position: 55
identifier: "migrations-interfaces"
---
# Migration Features
# Migration Interfaces
Complete migrations were introduced in Gitea 1.9.0. It defines two interfaces to support migrating
repository data from other Git host platforms to Gitea or, in the future, migrating Gitea data to other Git host platforms.
@@ -1,16 +1,7 @@
---
date: "2019-04-19:44:00+01:00"
title: "OAuth2 provider"
slug: "oauth2-provider"
sidebar_position: 41
toc: false
draft: false
menu:
sidebar:
parent: "development"
name: "OAuth2 Provider"
sidebar_position: 41
identifier: "oauth2-provider"
---
# OAuth2 provider
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2017-01-20T15:00:00+08:00"
title: "Help"
slug: "help"
sidebar_position: 5
toc: false
draft: false
menu:
sidebar:
name: "Help"
+1 -10
View File
@@ -1,19 +1,10 @@
---
date: "2019-04-05T16:00:00+02:00"
title: "FAQ"
slug: "faq"
sidebar_position: 5
toc: false
draft: false
menu:
sidebar:
parent: "help"
name: "FAQ"
sidebar_position: 5
identifier: "faq"
---
# Frequently Asked Questions <!-- omit in toc -->
# Frequently Asked Questions
This page contains some common questions and answers.
@@ -1,16 +1,7 @@
---
date: "2018-05-21T15:00:00+00:00"
title: "Support Options"
slug: "seek-help"
sidebar_position: 20
toc: false
draft: false
menu:
sidebar:
parent: "help"
name: "Support Options"
sidebar_position: 20
identifier: "seek-help"
---
# Support Options
+2 -3
View File
@@ -1,10 +1,9 @@
---
date: "2016-11-08T16:00:00+02:00"
title: "Documentation"
slug: /
sidebar_position: 10
toc: false
draft: false
---
# What is Gitea?
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Installation"
slug: "installation"
sidebar_position: 10
toc: false
draft: false
menu:
sidebar:
name: "Installation"
@@ -1,19 +1,11 @@
---
date: "2018-05-07T13:00:00+02:00"
title: "Gitea compared to other Git hosting options"
slug: "comparison"
sidebar_position: 5
toc: false
draft: false
menu:
sidebar:
name: "Comparison"
sidebar_position: 5
parent: installation
identifier: "comparison"
---
# Gitea compared to other Git hosting options
# Compared to other Git hosting
To help decide if Gitea is suited for your needs, here is how it compares to other Git self hosted options.
@@ -1,16 +1,7 @@
---
date: "2020-01-16"
title: "Database Preparation"
slug: "database-prep"
sidebar_position: 10
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "Database preparation"
sidebar_position: 10
identifier: "database-prep"
---
# Database Preparation
@@ -1,16 +1,10 @@
---
date: "2017-06-19T12:00:00+02:00"
title: "Installation from binary"
slug: "install-from-binary"
sidebar_position: 15
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "From binary"
sidebar_position: 15
identifier: "install-from-binary"
---
# Installation from binary
@@ -1,16 +1,7 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Installation from package"
slug: "install-from-package"
sidebar_position: 20
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "From package"
sidebar_position: 20
identifier: "install-from-package"
---
# Installation from package
@@ -1,16 +1,7 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Installation from source"
slug: "install-from-source"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "From source"
sidebar_position: 30
identifier: "install-from-source"
---
# Installation from source
@@ -1,16 +1,7 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Install on Cloud Provider"
slug: "install-on-cloud-provider"
sidebar_position: 90
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "On cloud provider"
sidebar_position: 90
identifier: "install-on-cloud-provider"
---
# Installation on Cloud Provider
@@ -1,19 +1,10 @@
---
date: "2020-03-19T19:27:00+02:00"
title: "Install on Kubernetes"
slug: "install-on-kubernetes"
sidebar_position: 80
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "Kubernetes"
sidebar_position: 80
identifier: "install-on-kubernetes"
---
# Installation with Helm (on Kubernetes)
# Install on Kubernetes
Gitea provides a Helm Chart to allow for installation on kubernetes.
@@ -1,23 +1,14 @@
---
date: "2017-07-21T12:00:00+02:00"
title: "Run as service in Linux"
slug: "linux-service"
sidebar_position: 40
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "Linux service"
sidebar_position: 40
identifier: "linux-service"
---
### Run Gitea as Linux service
# Run as Linux service
You can run Gitea as service, using either systemd or supervisor. The steps below tested on Ubuntu 16.04, but those should work on any Linux distributions (with little modification).
#### Using systemd
## Using systemd
Copy the sample [gitea.service](https://github.com/go-gitea/gitea/blob/main/contrib/systemd/gitea.service) to `/etc/systemd/system/gitea.service`, then edit the file with your favorite editor.
@@ -39,7 +30,7 @@ If you have systemd version 220 or later, you can enable and immediately start G
sudo systemctl enable gitea --now
```
#### Using supervisor
## Using supervisor
Install supervisor by running below command in terminal:
@@ -1,16 +1,10 @@
---
date: "2021-09-02T16:00:00+08:00"
title: "Upgrade from an old Gitea"
slug: "upgrade-from-gitea"
sidebar_position: 100
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "Upgrade From Old Gitea"
sidebar_position: 100
identifier: "upgrade-from-gitea"
---
# Upgrade from an old Gitea
@@ -1,16 +1,7 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Upgrade from Gogs"
slug: "upgrade-from-gogs"
sidebar_position: 101
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "Upgrade From Gogs"
sidebar_position: 101
identifier: "upgrade-from-gogs"
---
# Upgrade from Gogs
@@ -1,19 +1,12 @@
---
date: "2016-12-21T15:00:00-02:00"
title: "Register as a Windows Service"
slug: "windows-service"
sidebar_position: 50
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "Windows Service"
sidebar_position: 50
identifier: "windows-service"
---
# Prerequisites
# Register as a Windows Service
## Prerequisites
The following changes are made in C:\gitea\custom\conf\app.ini:
@@ -25,7 +18,7 @@ Sets Gitea to run as the local system user.
COMPUTERNAME is whatever the response is from `echo %COMPUTERNAME%` on the command line. If the response is `USER-PC` then `RUN_USER = USER-PC$`
## Use absolute paths
### Use absolute paths
If you use SQLite3, change the `PATH` to include the full path:
@@ -34,7 +27,7 @@ If you use SQLite3, change the `PATH` to include the full path:
PATH = c:/gitea/data/gitea.db
```
# Register as a Windows Service
## Register as a Windows Service
To register Gitea as a Windows service, open a command prompt (cmd) as an Administrator,
then run the following command:
@@ -49,7 +42,7 @@ Open "Windows Services", search for the service named "gitea", right-click it an
"Run". If everything is OK, Gitea will be reachable on `http://localhost:3000` (or the port
that was configured).
## Adding startup dependencies
### Adding startup dependencies
To add a startup dependency to the Gitea Windows service (eg Mysql, Mariadb), as an Administrator, then run the following command:
@@ -59,7 +52,7 @@ sc.exe config gitea depend= mariadb
This will ensure that when the Windows machine restarts, the automatic starting of Gitea is postponed until the database is ready and thus mitigate failed startups.
## Unregister as a service
### Unregister as a service
To unregister Gitea as a service, open a command prompt (cmd) as an Administrator and run:
@@ -1,19 +1,10 @@
---
date: "2020-02-09T20:00:00+02:00"
title: "Installation with Docker (rootless)"
slug: "install-with-docker-rootless"
sidebar_position: 60
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "With Docker Rootless"
sidebar_position: 60
identifier: "install-with-docker-rootless"
---
# Installation with Docker
# Installation with Docker (rootless)
Gitea provides automatically updated Docker images within its Docker Hub organization. It is
possible to always use the latest stable tag or to use another service that handles updating
@@ -1,16 +1,7 @@
---
date: "2020-03-19T19:27:00+02:00"
title: "Installation with Docker"
slug: "install-with-docker"
sidebar_position: 70
toc: false
draft: false
menu:
sidebar:
parent: "installation"
name: "With Docker"
sidebar_position: 70
identifier: "install-with-docker"
---
# Installation with Docker
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2016-12-27T16:00:00+02:00"
title: "Packages"
slug: "packages"
sidebar_position: 35
toc: false
draft: false
menu:
sidebar:
name: "Usage - Packages"
@@ -1,16 +1,7 @@
---
date: "2022-11-20T00:00:00+00:00"
title: "Cargo Packages Repository"
slug: "usage/packages/cargo"
sidebar_position: 5
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Cargo"
sidebar_position: 5
identifier: "cargo"
---
# Cargo Packages Repository
@@ -1,16 +1,7 @@
---
date: "2023-01-20T00:00:00+00:00"
title: "Chef Packages Repository"
slug: "usage/packages/chef"
sidebar_position: 5
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Chef"
sidebar_position: 5
identifier: "chef"
---
# Chef Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "Composer Packages Repository"
slug: "usage/packages/composer"
sidebar_position: 10
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Composer"
sidebar_position: 10
identifier: "composer"
---
# Composer Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "Conan Packages Repository"
slug: "usage/packages/conan"
sidebar_position: 20
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Conan"
sidebar_position: 20
identifier: "conan"
---
# Conan Packages Repository
@@ -1,16 +1,8 @@
---
date: "2022-12-28T00:00:00+00:00"
title: "Conda Packages Repository"
slug: "usage/packages/conda"
sidebar_position: 25
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Conda"
sidebar_position: 25
identifier: "conda"
---
# Conda Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "Container Registry"
slug: "usage/packages/container"
sidebar_position: 30
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Container Registry"
sidebar_position: 30
identifier: "container"
---
# Container Registry
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "Generic Packages Repository"
slug: "usage/packages/generic"
sidebar_position: 40
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Generic"
sidebar_position: 40
identifier: "generic"
---
# Generic Packages Repository
+2 -9
View File
@@ -1,16 +1,9 @@
---
date: "2022-04-14T00:00:00+00:00"
title: "Helm Chart Registry"
slug: "usage/packages/helm"
sidebar_position: 50
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Helm"
sidebar_position: 50
identifier: "helm"
---
# Helm Chart Registry
@@ -1,16 +1,8 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "Maven Packages Repository"
slug: "usage/packages/maven"
sidebar_position: 60
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Maven"
sidebar_position: 60
identifier: "maven"
---
# Maven Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "npm Packages Repository"
slug: "usage/packages/npm"
sidebar_position: 70
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "npm"
sidebar_position: 70
identifier: "npm"
---
# npm Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "NuGet Packages Repository"
slug: "usage/packages/nuget"
sidebar_position: 80
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "NuGet"
sidebar_position: 80
identifier: "nuget"
---
# NuGet Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "Package Registry"
slug: "usage/packages/overview"
sidebar_position: 1
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Overview"
sidebar_position: 1
identifier: "packages-overview"
---
# Package Registry
@@ -1,16 +1,7 @@
---
date: "2022-07-31T00:00:00+00:00"
title: "Pub Packages Repository"
slug: "usage/packages/pub"
sidebar_position: 90
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Pub"
sidebar_position: 90
identifier: "pub"
---
# Pub Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "PyPI Packages Repository"
slug: "usage/packages/pypi"
sidebar_position: 100
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "PyPI"
sidebar_position: 100
identifier: "pypi"
---
# PyPI Packages Repository
@@ -1,16 +1,7 @@
---
date: "2021-07-20T00:00:00+00:00"
title: "RubyGems Packages Repository"
slug: "usage/packages/rubygems"
sidebar_position: 110
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "RubyGems"
sidebar_position: 110
identifier: "rubygems"
---
# RubyGems Packages Repository
@@ -1,16 +1,7 @@
---
date: "2022-11-01T00:00:00+00:00"
title: "Storage"
slug: "usage/packages/storage"
sidebar_position: 5
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Storage"
sidebar_position: 5
identifier: "storage"
---
# Storage
@@ -1,16 +1,7 @@
---
date: "2022-08-23T00:00:00+00:00"
title: "Vagrant Packages Repository"
slug: "usage/packages/vagrant"
sidebar_position: 120
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Vagrant"
sidebar_position: 120
identifier: "vagrant"
---
# Vagrant Packages Repository
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2016-12-27T16:00:00+02:00"
title: "Usage"
slug: "usage"
sidebar_position: 35
toc: false
draft: false
menu:
sidebar:
name: "Usage"
@@ -1,16 +1,10 @@
---
date: " 2022-09-01T20:50:42+0000"
title: "Agit Setup"
slug: "agit-setup"
sidebar_position: 12
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Agit Setup"
sidebar_position: 12
identifier: "agit-setup"
---
# Agit Setup
@@ -1,16 +1,10 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Authentication"
slug: "authentication"
sidebar_position: 10
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Authentication"
sidebar_position: 10
identifier: "authentication"
---
# Authentication
@@ -1,16 +1,9 @@
---
date: "2021-02-02"
title: "Clone filters (partial clone)"
slug: "clone-filters"
sidebar_position: 25
draft: false
toc: false
menu:
sidebar:
parent: "usage"
name: "Clone filters"
sidebar_position: 25
identifier: "clone-filters"
---
# Clone filters (partial clone)
@@ -1,16 +1,9 @@
---
date: "2022-12-01T00:00:00+00:00"
title: "Incoming Email"
slug: "incoming-email"
sidebar_position: 13
draft: false
toc: false
menu:
sidebar:
parent: "usage"
name: "Incoming Email"
sidebar_position: 13
identifier: "incoming-email"
---
# Incoming Email
@@ -1,16 +1,10 @@
---
date: "2018-05-10T16:00:00+02:00"
title: "Issue and Pull Request templates"
slug: "issue-pull-request-templates"
sidebar_position: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Issue and Pull Request templates"
sidebar_position: 15
identifier: "issue-pull-request-templates"
---
# Issue and Pull Request Templates
+3 -9
View File
@@ -1,16 +1,10 @@
---
date: "2023-03-04T19:00:00+00:00"
title: "Labels"
slug: "labels"
sidebar_position: 13
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Labels"
sidebar_position: 13
identifier: "labels"
---
# Labels
@@ -1,19 +1,10 @@
---
date: "2019-11-21T17:00:00-03:00"
title: "Automatically Linked References"
slug: "automatically-linked-references"
sidebar_position: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Automatically Linked References"
sidebar_position: 15
identifier: "automatically-linked-references"
---
# Automatically Linked References in Issues, Pull Requests and Commit Messages
# Automatically Linked References
When an issue, pull request or comment is posted, the text description is parsed
in search for references. These references will be shown as links in the Issue View
@@ -1,10 +1,8 @@
---
date: "2022-08-31T17:35:40+08:00"
title: "Merge Message templates"
slug: "merge-message-templates"
sidebar_position: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
@@ -1,16 +1,7 @@
---
date: "2021-12-13:10:10+08:00"
title: "Permissions"
slug: "permissions"
sidebar_position: 14
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Permissions"
sidebar_position: 14
identifier: "permissions"
---
# Permissions
@@ -1,16 +1,10 @@
---
date: "2021-05-14T00:00:00-00:00"
title: "Protected tags"
slug: "protected-tags"
sidebar_position: 45
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Protected tags"
sidebar_position: 45
identifier: "protected-tags"
---
# Protected tags
@@ -1,16 +1,10 @@
---
date: "2018-06-01T19:00:00+02:00"
title: "Pull Request"
slug: "pull-request"
sidebar_position: 13
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Pull Request"
sidebar_position: 13
identifier: "pull-request"
---
# Pull Request
+8 -15
View File
@@ -1,21 +1,14 @@
---
date: "2020-07-06T16:00:00+02:00"
title: "Push"
slug: "push"
sidebar_position: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Push"
sidebar_position: 15
identifier: "push"
---
# Push
There are some additional features when pushing commits to Gitea server.
# Open PR through Push
## Open PR through Push
When you push commits to a non-default branch for the first time,
you will receive a link you can click on to visit the compare page of your branch compared to your main branch.
@@ -23,12 +16,12 @@ From there, it's easy to create a pull request, even if you want to target anoth
![Gitea Push Hint](/gitea-push-hint.png)
# Push Options
## Push Options
In Gitea `1.13`, support for some [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)
were added.
## Supported Options
### Supported Options
- `repo.private` (true|false) - Change the repository's visibility.
@@ -42,15 +35,15 @@ Example of changing a repository's visibility to public:
git push -o repo.private=false -u origin main
```
# Push To Create
## Push To Create
Push to create is a feature that allows you to push to a repository that does not exist yet in Gitea. This is useful for automation and for allowing users to create repositories without having to go through the web interface. This feature is disabled by default.
## Enabling Push To Create
### Enabling Push To Create
In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet](../administration/config-cheat-sheet.md#repository-repository).
## Using Push To Create
### Using Push To Create
Assuming you have a git repository in the current directory, you can push to a repository that does not exist yet in Gitea by running the following command:
@@ -1,16 +1,7 @@
---
date: "2021-05-13T00:00:00-00:00"
title: "Repository Mirror"
slug: "repo-mirror"
sidebar_position: 45
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Repository Mirror"
sidebar_position: 45
identifier: "repo-mirror"
---
# Repository Mirror
+3 -12
View File
@@ -1,16 +1,7 @@
---
date: "2024-07-10T09:23:00+02:00"
title: "Secrets"
slug: "usage/secrets"
sidebar_position: 50
draft: false
toc: false
menu:
sidebar:
parent: "usage"
name: "Secrets"
sidebar_position: 50
identifier: "usage-secrets"
---
# Secrets
@@ -18,7 +9,7 @@ menu:
Secrets allow you to store sensitive information in your user, organization or repository.
Secrets are available on Gitea 1.19+.
# Naming your secrets
## Naming your secrets
The following rules apply to secret names:
@@ -34,11 +25,11 @@ The following rules apply to secret names:
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.
### Using secrets
## Using secrets
After creating configuration variables, they will be automatically filled in the `secrets` context.
They can be accessed through expressions like `${{ secrets.SECRET_NAME }}` in the workflow.
### Precedence
## Precedence
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.
@@ -1,16 +1,7 @@
---
date: "2019-11-28:00:00+02:00"
title: "Template Repositories"
slug: "template-repositories"
sidebar_position: 14
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Template Repositories"
sidebar_position: 14
identifier: "template-repositories"
---
# Template Repositories
@@ -1,16 +1,10 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Webhooks"
slug: "webhooks"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Webhooks"
sidebar_position: 30
identifier: "webhooks"
---
# Webhooks
+1 -2
View File
@@ -3,8 +3,7 @@ date: "2023-04-27T14:00:00+08:00"
title: "Actions"
slug: "actions"
sidebar_position: 36
toc: false
draft: false
menu:
sidebar:
name: "Usage - Actions"
@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Administration"
slug: "administration"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
name: "Administration"
@@ -1,20 +1,13 @@
---
date: "2019-12-28"
title: "Adding Legal Pages"
slug: adding-legal-pages
sidebar_position: 110
toc: false
draft: false
aliases:
- /en-us/adding-legal-pages
menu:
sidebar:
parent: "administration"
name: "Adding Legal Pages"
identifier: "adding-legal-pages"
sidebar_position: 110
---
# Adding Legal Pages
Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance.
## Getting Pages
@@ -1,18 +1,11 @@
---
date: "2017-01-01T16:00:00+02:00"
title: "Backup and Restore"
slug: "backup-and-restore"
sidebar_position: 11
toc: false
draft: false
aliases:
- /en-us/backup-and-restore
menu:
sidebar:
parent: "administration"
name: "Backup and Restore"
sidebar_position: 11
identifier: "backup-and-restore"
---
# Backup and Restore
@@ -1,18 +1,11 @@
---
date: "2020-01-25T21:00:00-03:00"
title: "Embedded data extraction tool"
slug: "cmd-embedded"
sidebar_position: 20
toc: false
draft: false
aliases:
- /en-us/cmd-embedded
menu:
sidebar:
parent: "administration"
name: "Embedded data extraction tool"
sidebar_position: 20
identifier: "cmd-embedded"
---
# Embedded data extraction tool
@@ -1,18 +1,9 @@
---
date: "2017-01-01T16:00:00+02:00"
title: "Gitea Command Line"
slug: "command-line"
sidebar_position: 1
toc: false
draft: false
aliases:
- /en-us/command-line
menu:
sidebar:
parent: "administration"
name: "Command Line"
sidebar_position: 1
identifier: "command-line"
---
# Command Line
@@ -404,11 +395,11 @@ append it to `doctor.go`.
```go
var checklist = []check{
{
title: "Check if OpenSSH authorized_keys file id correct",
f: runDoctorLocationMoved,
},
// more checks please append here
{
title: "Check if OpenSSH authorized_keys file id correct",
f: runDoctorLocationMoved,
},
// more checks please append here
}
```
@@ -1,18 +1,12 @@
---
date: "2016-12-26T16:00:00+02:00"
title: "Config Cheat Sheet"
slug: "config-cheat-sheet"
sidebar_position: 30
toc: false
draft: false
aliases:
- /en-us/config-cheat-sheet
menu:
sidebar:
parent: "administration"
name: "Config Cheat Sheet"
sidebar_position: 30
identifier: "config-cheat-sheet"
---
# Configuration Cheat Sheet
@@ -1,18 +1,9 @@
---
date: "2017-04-15T14:56:00+02:00"
title: "Customizing Gitea"
slug: "customizing-gitea"
sidebar_position: 100
toc: false
draft: false
aliases:
- /en-us/customizing-gitea
menu:
sidebar:
parent: "administration"
name: "Customizing Gitea"
identifier: "customizing-gitea"
sidebar_position: 100
---
# Customizing Gitea
@@ -1,18 +1,11 @@
---
date: "2019-10-15T10:10:00+05:00"
title: "Email setup"
slug: "email-setup"
sidebar_position: 12
toc: false
draft: false
aliases:
- /en-us/email-setup
menu:
sidebar:
parent: "administration"
name: "Email setup"
sidebar_position: 12
identifier: "email-setup"
---
# Email setup
@@ -1,18 +1,11 @@
---
date: "2017-04-08T11:34:00+02:00"
title: "Environment variables"
slug: "environment-variables"
sidebar_position: 10
toc: false
draft: false
aliases:
- /en-us/environment-variables
menu:
sidebar:
parent: "administration"
name: "Environment variables"
sidebar_position: 10
identifier: "environment-variables"
---
# Environment variables
@@ -1,21 +1,14 @@
---
date: "2018-11-23:00:00+02:00"
title: "External renderers"
slug: "external-renderers"
sidebar_position: 60
toc: false
draft: false
aliases:
- /en-us/external-renderers
menu:
sidebar:
parent: "administration"
name: "External renderers"
sidebar_position: 60
identifier: "external-renderers"
---
# Custom files rendering configuration
# External renderers
Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries,
it is just a matter of:
@@ -1,21 +1,15 @@
---
date: "2018-05-11T11:00:00+02:00"
title: "Fail2ban Setup "
slug: "fail2ban-setup"
sidebar_position: 16
toc: false
draft: false
aliases:
- /en-us/fail2ban-setup
menu:
sidebar:
parent: "administration"
name: "Fail2ban setup"
sidebar_position: 16
identifier: "fail2ban-setup"
---
# Fail2ban setup to block users after failed login attempts
# Fail2ban Setup
**Remember that fail2ban is powerful and can cause lots of issues if you do it incorrectly, so make
sure to test this before relying on it so you don't lock yourself out.**
@@ -1,21 +1,14 @@
---
date: "2019-10-06T08:00:00+05:00"
title: "Git LFS setup"
slug: "git-lfs-setup"
sidebar_position: 12
toc: false
draft: false
aliases:
- /en-us/git-lfs-setup
menu:
sidebar:
parent: "administration"
name: "Git LFS setup"
sidebar_position: 12
identifier: "git-lfs-setup"
---
# Git Large File Storage setup
# Git LFS setup
To use Gitea's built-in LFS support, you must update the `app.ini` file:
@@ -1,21 +1,12 @@
---
date: "2018-06-02T11:00:00+02:00"
title: "HTTPS setup"
slug: "https-setup"
sidebar_position: 12
toc: false
draft: false
aliases:
- /en-us/https-setup
menu:
sidebar:
parent: "administration"
name: "HTTPS setup"
sidebar_position: 12
identifier: "https-setup"
---
# HTTPS setup to encrypt connections to Gitea
# HTTPS setup
## Using the built-in server
@@ -1,18 +1,9 @@
---
date: "2019-04-02T17:06:00+01:00"
title: "Logging Configuration"
slug: "logging-config"
sidebar_position: 40
toc: false
draft: false
aliases:
- /en-us/logging-configuration
menu:
sidebar:
parent: "administration"
name: "Logging Configuration"
sidebar_position: 40
identifier: "logging-config"
---
# Logging Configuration
@@ -1,18 +1,11 @@
---
date: "2019-10-23T17:00:00-03:00"
title: "Mail templates"
slug: "mail-templates"
sidebar_position: 45
toc: false
draft: false
aliases:
- /en-us/mail-templates
menu:
sidebar:
parent: "administration"
name: "Mail templates"
sidebar_position: 45
identifier: "mail-templates"
---
# Mail templates
@@ -1,18 +1,11 @@
---
date: "2019-09-06T01:35:00-03:00"
title: "Repository indexer"
slug: "repo-indexer"
sidebar_position: 45
toc: false
draft: false
aliases:
- /en-us/repo-indexer
menu:
sidebar:
parent: "administration"
name: "Repository indexer"
sidebar_position: 45
identifier: "repo-indexer"
---
# Repository indexer

Some files were not shown because too many files have changed in this diff Show More