Compare commits
19 commits
next
...
backport/v
Author | SHA1 | Date | |
---|---|---|---|
07865ed7ff | |||
|
b08aaf57c8 | ||
|
d39405ea95 | ||
|
81c31abdd5 | ||
7acc15dbca | |||
845378b29d | |||
f89d4d568d | |||
f0b99af484 | |||
88bd56c31c | |||
|
c06d726ecf | ||
46e5cf2f22 | |||
05c3a5d43d | |||
|
f37365b4bc | ||
|
11048364ab | ||
|
6045d15696 | ||
726f8cb2bc | |||
|
71ce2ff514 | ||
c874343142 | |||
e9523e7732 |
62 changed files with 1637 additions and 1200 deletions
|
@ -4,6 +4,7 @@ on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- 'next'
|
- 'next'
|
||||||
|
- 'v7.0'
|
||||||
- 'v1.21'
|
- 'v1.21'
|
||||||
- 'v1.20'
|
- 'v1.20'
|
||||||
- 'v1.19'
|
- 'v1.19'
|
||||||
|
|
|
@ -13,6 +13,7 @@ a new branch will be created in this repo to document the stable release.
|
||||||
Current release branches are as follows:
|
Current release branches are as follows:
|
||||||
|
|
||||||
- [`next`](https://codeberg.org/forgejo/docs/src/branch/next)
|
- [`next`](https://codeberg.org/forgejo/docs/src/branch/next)
|
||||||
|
- [`v7.0`](https://codeberg.org/forgejo/docs/src/branch/v7.0)
|
||||||
- [`v1.21`](https://codeberg.org/forgejo/docs/src/branch/v1.21)
|
- [`v1.21`](https://codeberg.org/forgejo/docs/src/branch/v1.21)
|
||||||
- [`v1.20`](https://codeberg.org/forgejo/docs/src/branch/v1.20)
|
- [`v1.20`](https://codeberg.org/forgejo/docs/src/branch/v1.20)
|
||||||
- [`v1.19`](https://codeberg.org/forgejo/docs/src/branch/v1.19)
|
- [`v1.19`](https://codeberg.org/forgejo/docs/src/branch/v1.19)
|
||||||
|
@ -119,7 +120,7 @@ version branches into which it will potentially be merged.
|
||||||
#### Backports
|
#### Backports
|
||||||
|
|
||||||
If a PR is meant to be backported to a stable branch, it must be
|
If a PR is meant to be backported to a stable branch, it must be
|
||||||
labelled with `backport/v1.20`, `backport/v1.19`, etc.
|
labelled with `backport/v7.0`, `backport/v1.21`, etc.
|
||||||
|
|
||||||
### Content guidelines
|
### Content guidelines
|
||||||
|
|
||||||
|
|
|
@ -15,32 +15,33 @@ To update this page, run the following command from the root of the docs repo:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo - Beyond coding. We forge.
|
forgejo - Beyond coding. We forge.
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo [global options] command [command options] [arguments...]
|
forgejo [global options] command [command options]
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
By default, forgejo will start serving using the web-server with no argument, which can alternatively be run by running the subcommand "web".
|
By default, forgejo will start serving using the web-server with no argument, which can alternatively be run by running the subcommand "web".
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
|
help, h Shows a list of commands or help for one command
|
||||||
web Start the Forgejo web server
|
web Start the Forgejo web server
|
||||||
serv This command should only be called by SSH shell
|
serv (internal) Should only be called by SSH shell
|
||||||
hook Delegate commands to corresponding Git hooks
|
hook (internal) Should only be called by Git
|
||||||
|
keys (internal) Should only be called by SSH server
|
||||||
dump Dump Forgejo files and database
|
dump Dump Forgejo files and database
|
||||||
admin Command line interface to perform common administrative operations
|
admin Perform common administrative operations
|
||||||
migrate Migrate the database
|
migrate Migrate the database
|
||||||
keys This command queries the Forgejo database to get the authorized command for a given ssh key fingerprint
|
doctor Diagnose and optionally fix problems, convert or re-create database tables
|
||||||
doctor Diagnose and optionally fix problems
|
|
||||||
manager Manage the running forgejo process
|
manager Manage the running forgejo process
|
||||||
embedded Extract embedded resources
|
embedded Extract embedded resources
|
||||||
migrate-storage Migrate the storage
|
migrate-storage Migrate the storage
|
||||||
dump-repo Dump the repository from git/github/gitea/gitlab
|
dump-repo Dump the repository from git/github/gitea/gitlab
|
||||||
restore-repo Restore the repository from disk
|
restore-repo Restore the repository from disk
|
||||||
help, h Shows a list of commands or help for one command
|
actions Manage Forgejo Actions
|
||||||
cert Generate self-signed certificate
|
cert Generate self-signed certificate
|
||||||
generate Command line interface for running generators
|
generate Generate Gitea's secrets/keys/tokens
|
||||||
docs Output CLI documentation
|
docs Output CLI documentation
|
||||||
forgejo-cli Forgejo CLI
|
forgejo-cli Forgejo CLI
|
||||||
|
|
||||||
|
@ -56,10 +57,10 @@ GLOBAL OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo forgejo-cli - Forgejo CLI
|
forgejo forgejo-cli - Forgejo CLI
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo forgejo-cli command [command options] [arguments...]
|
forgejo forgejo-cli command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
actions Commands for managing Forgejo Actions
|
actions Commands for managing Forgejo Actions
|
||||||
|
@ -73,10 +74,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo forgejo-cli actions - Commands for managing Forgejo Actions
|
forgejo forgejo-cli actions - Commands for managing Forgejo Actions
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo forgejo-cli actions command [command options] [arguments...]
|
forgejo forgejo-cli actions command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
generate-runner-token Generate a new token for a runner to use to register with the server
|
generate-runner-token Generate a new token for a runner to use to register with the server
|
||||||
|
@ -92,10 +93,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo forgejo-cli actions generate-runner-token - Generate a new token for a runner to use to register with the server
|
forgejo forgejo-cli actions generate-runner-token - Generate a new token for a runner to use to register with the server
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo forgejo-cli actions generate-runner-token [command options] [arguments...]
|
forgejo forgejo-cli actions generate-runner-token [command options] [arguments...]
|
||||||
|
|
||||||
OPTIONS:
|
OPTIONS:
|
||||||
--scope value, -s value {owner}[/{repo}] - leave empty for a global runner
|
--scope value, -s value {owner}[/{repo}] - leave empty for a global runner
|
||||||
|
@ -106,10 +107,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo forgejo-cli actions generate-secret - Generate a secret suitable for input to the register subcommand
|
forgejo forgejo-cli actions generate-secret - Generate a secret suitable for input to the register subcommand
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo forgejo-cli actions generate-secret [command options] [arguments...]
|
forgejo forgejo-cli actions generate-secret [command options] [arguments...]
|
||||||
|
|
||||||
OPTIONS:
|
OPTIONS:
|
||||||
--help, -h show help
|
--help, -h show help
|
||||||
|
@ -119,10 +120,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo forgejo-cli actions register - Idempotent registration of a runner using a shared secret
|
forgejo forgejo-cli actions register - Idempotent registration of a runner using a shared secret
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo forgejo-cli actions register [command options] [arguments...]
|
forgejo forgejo-cli actions register [command options] [arguments...]
|
||||||
|
|
||||||
OPTIONS:
|
OPTIONS:
|
||||||
--secret value the secret the runner will use to connect as a 40 character hexadecimal string
|
--secret value the secret the runner will use to connect as a 40 character hexadecimal string
|
||||||
|
@ -139,10 +140,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo web - Start the Forgejo web server
|
forgejo web - Start the Forgejo web server
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo web command [command options] [arguments...]
|
forgejo web command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
The Forgejo web server is the only thing you need to run,
|
The Forgejo web server is the only thing you need to run,
|
||||||
|
@ -167,10 +168,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo dump - Dump Forgejo files and database
|
forgejo dump - Dump Forgejo files and database
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo dump command [command options] [arguments...]
|
forgejo dump command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
Dump compresses all related files and database into zip file.
|
Dump compresses all related files and database into zip file.
|
||||||
|
@ -203,10 +204,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin - Command line interface to perform common administrative operations
|
forgejo admin - Perform common administrative operations
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin command [command options] [arguments...]
|
forgejo admin command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
user Modify users
|
user Modify users
|
||||||
|
@ -227,10 +228,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user - Modify users
|
forgejo admin user - Modify users
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user command [command options] [arguments...]
|
forgejo admin user command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
create Create a new user in database
|
create Create a new user in database
|
||||||
|
@ -252,10 +253,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user create - Create a new user in database
|
forgejo admin user create - Create a new user in database
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user create command [command options] [arguments...]
|
forgejo admin user create command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -271,7 +272,7 @@ OPTIONS:
|
||||||
--email value User email address
|
--email value User email address
|
||||||
--admin User is an admin (default: false)
|
--admin User is an admin (default: false)
|
||||||
--random-password Generate a random password for the user (default: false)
|
--random-password Generate a random password for the user (default: false)
|
||||||
--must-change-password Set this option to false to prevent forcing the user to change their password after initial login, (Default: true) (default: false)
|
--must-change-password Set this option to false to prevent forcing the user to change their password after initial login
|
||||||
--random-password-length value Length of the random password to be generated (default: 12)
|
--random-password-length value Length of the random password to be generated (default: 12)
|
||||||
--access-token Generate access token for the user (default: false)
|
--access-token Generate access token for the user (default: false)
|
||||||
--restricted Make a restricted user account (default: false)
|
--restricted Make a restricted user account (default: false)
|
||||||
|
@ -281,10 +282,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user list - List users
|
forgejo admin user list - List users
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user list command [command options] [arguments...]
|
forgejo admin user list command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -301,10 +302,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user change-password - Change a user's password
|
forgejo admin user change-password - Change a user's password
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user change-password command [command options] [arguments...]
|
forgejo admin user change-password command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -316,16 +317,17 @@ OPTIONS:
|
||||||
--work-path value, -w value Set Forgejo's working path (defaults to the directory of the Forgejo binary)
|
--work-path value, -w value Set Forgejo's working path (defaults to the directory of the Forgejo binary)
|
||||||
--username value, -u value The user to change password for
|
--username value, -u value The user to change password for
|
||||||
--password value, -p value New password to set for user
|
--password value, -p value New password to set for user
|
||||||
|
--must-change-password User must change password (default: true)
|
||||||
```
|
```
|
||||||
|
|
||||||
### admin user delete
|
### admin user delete
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user delete - Delete specific user by id, name or email
|
forgejo admin user delete - Delete specific user by id, name or email
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user delete command [command options] [arguments...]
|
forgejo admin user delete command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -345,10 +347,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user generate-access-token - Generate an access token for a specific user
|
forgejo admin user generate-access-token - Generate an access token for a specific user
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user generate-access-token command [command options] [arguments...]
|
forgejo admin user generate-access-token command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -368,10 +370,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin user must-change-password - Set the must change password flag for the provided users or all users
|
forgejo admin user must-change-password - Set the must change password flag for the provided users or all users
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin user must-change-password command [command options] [arguments...]
|
forgejo admin user must-change-password command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -390,10 +392,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin repo-sync-releases - Synchronize repository releases with tags
|
forgejo admin repo-sync-releases - Synchronize repository releases with tags
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin repo-sync-releases command [command options] [arguments...]
|
forgejo admin repo-sync-releases command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -409,10 +411,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin regenerate - Regenerate specific files
|
forgejo admin regenerate - Regenerate specific files
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin regenerate command [command options] [arguments...]
|
forgejo admin regenerate command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
hooks Regenerate git-hooks
|
hooks Regenerate git-hooks
|
||||||
|
@ -430,10 +432,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth - Modify external auth providers
|
forgejo admin auth - Modify external auth providers
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth command [command options] [arguments...]
|
forgejo admin auth command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
add-oauth Add new Oauth authentication source
|
add-oauth Add new Oauth authentication source
|
||||||
|
@ -459,10 +461,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth add-oauth - Add new Oauth authentication source
|
forgejo admin auth add-oauth - Add new Oauth authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth add-oauth command [command options] [arguments...]
|
forgejo admin auth add-oauth command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -499,10 +501,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth update-oauth - Update existing Oauth authentication source
|
forgejo admin auth update-oauth - Update existing Oauth authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth update-oauth command [command options] [arguments...]
|
forgejo admin auth update-oauth command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -540,10 +542,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth add-ldap - Add new LDAP (via Bind DN) authentication source
|
forgejo admin auth add-ldap - Add new LDAP (via Bind DN) authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth add-ldap command [command options] [arguments...]
|
forgejo admin auth add-ldap command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -584,10 +586,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth update-ldap - Update existing LDAP (via Bind DN) authentication source
|
forgejo admin auth update-ldap - Update existing LDAP (via Bind DN) authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth update-ldap command [command options] [arguments...]
|
forgejo admin auth update-ldap command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -629,10 +631,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth add-ldap-simple - Add new LDAP (simple auth) authentication source
|
forgejo admin auth add-ldap-simple - Add new LDAP (simple auth) authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth add-ldap-simple command [command options] [arguments...]
|
forgejo admin auth add-ldap-simple command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -661,17 +663,17 @@ OPTIONS:
|
||||||
--public-ssh-key-attribute value The attribute of the user’s LDAP record containing the user’s public ssh key.
|
--public-ssh-key-attribute value The attribute of the user’s LDAP record containing the user’s public ssh key.
|
||||||
--skip-local-2fa Set to true to skip local 2fa for users authenticated by this source (default: false)
|
--skip-local-2fa Set to true to skip local 2fa for users authenticated by this source (default: false)
|
||||||
--avatar-attribute value The attribute of the user’s LDAP record containing the user’s avatar.
|
--avatar-attribute value The attribute of the user’s LDAP record containing the user’s avatar.
|
||||||
--user-dn value The user’s DN.
|
--user-dn value The user's DN.
|
||||||
```
|
```
|
||||||
|
|
||||||
### admin auth update-ldap-simple
|
### admin auth update-ldap-simple
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth update-ldap-simple - Update existing LDAP (simple auth) authentication source
|
forgejo admin auth update-ldap-simple - Update existing LDAP (simple auth) authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth update-ldap-simple command [command options] [arguments...]
|
forgejo admin auth update-ldap-simple command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -701,17 +703,17 @@ OPTIONS:
|
||||||
--public-ssh-key-attribute value The attribute of the user’s LDAP record containing the user’s public ssh key.
|
--public-ssh-key-attribute value The attribute of the user’s LDAP record containing the user’s public ssh key.
|
||||||
--skip-local-2fa Set to true to skip local 2fa for users authenticated by this source (default: false)
|
--skip-local-2fa Set to true to skip local 2fa for users authenticated by this source (default: false)
|
||||||
--avatar-attribute value The attribute of the user’s LDAP record containing the user’s avatar.
|
--avatar-attribute value The attribute of the user’s LDAP record containing the user’s avatar.
|
||||||
--user-dn value The user’s DN.
|
--user-dn value The user's DN.
|
||||||
```
|
```
|
||||||
|
|
||||||
### admin auth add-smtp
|
### admin auth add-smtp
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth add-smtp - Add new SMTP authentication source
|
forgejo admin auth add-smtp - Add new SMTP authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth add-smtp command [command options] [arguments...]
|
forgejo admin auth add-smtp command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -738,10 +740,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth update-smtp - Update existing SMTP authentication source
|
forgejo admin auth update-smtp - Update existing SMTP authentication source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth update-smtp command [command options] [arguments...]
|
forgejo admin auth update-smtp command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -769,10 +771,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth list - List auth sources
|
forgejo admin auth list - List auth sources
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth list command [command options] [arguments...]
|
forgejo admin auth list command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -793,10 +795,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin auth delete - Delete specific auth source
|
forgejo admin auth delete - Delete specific auth source
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin auth delete command [command options] [arguments...]
|
forgejo admin auth delete command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -813,10 +815,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo admin sendmail - Send a message to all users
|
forgejo admin sendmail - Send a message to all users
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo admin sendmail command [command options] [arguments...]
|
forgejo admin sendmail command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -835,10 +837,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo migrate - Migrate the database
|
forgejo migrate - Migrate the database
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo migrate command [command options] [arguments...]
|
forgejo migrate command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
This is a command for migrating the database, so that you can run gitea admin create-user before starting the server.
|
This is a command for migrating the database, so that you can run gitea admin create-user before starting the server.
|
||||||
|
@ -857,10 +859,13 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo keys - This command queries the Forgejo database to get the authorized command for a given ssh key fingerprint
|
forgejo keys - (internal) Should only be called by SSH server
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo keys command [command options] [arguments...]
|
forgejo keys command [command options]
|
||||||
|
|
||||||
|
DESCRIPTION:
|
||||||
|
Queries the Forgejo database to get the authorized command for a given ssh key fingerprint
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -880,10 +885,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo doctor - Diagnose and optionally fix problems
|
forgejo doctor - Diagnose and optionally fix problems, convert or re-create database tables
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo doctor command [command options] [arguments...]
|
forgejo doctor command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.
|
A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.
|
||||||
|
@ -905,10 +910,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo doctor check - Diagnose and optionally fix problems
|
forgejo doctor check - Diagnose and optionally fix problems
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo doctor check command [command options] [arguments...]
|
forgejo doctor check command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.
|
A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.
|
||||||
|
@ -934,10 +939,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo doctor recreate-table - Recreate tables from XORM definitions and copy the data.
|
forgejo doctor recreate-table - Recreate tables from XORM definitions and copy the data.
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo doctor recreate-table command [command options] [TABLE]... : (TABLEs to recreate - leave blank for all)
|
forgejo doctor recreate-table command [command options] [TABLE]... : (TABLEs to recreate - leave blank for all)
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
The database definitions Forgejo uses change across versions, sometimes changing default values and leaving old unused columns.
|
The database definitions Forgejo uses change across versions, sometimes changing default values and leaving old unused columns.
|
||||||
|
@ -961,10 +966,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo doctor convert - Convert the database
|
forgejo doctor convert - Convert the database
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo doctor convert command [command options] [arguments...]
|
forgejo doctor convert command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
A command to convert an existing MySQL database from utf8 to utf8mb4 or MSSQL database from varchar to nvarchar
|
A command to convert an existing MySQL database from utf8 to utf8mb4 or MSSQL database from varchar to nvarchar
|
||||||
|
@ -983,10 +988,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager - Manage the running forgejo process
|
forgejo manager - Manage the running forgejo process
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager command [command options] [arguments...]
|
forgejo manager command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
This is a command for managing the running forgejo process
|
This is a command for managing the running forgejo process
|
||||||
|
@ -1011,10 +1016,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager shutdown - Gracefully shutdown the running process
|
forgejo manager shutdown - Gracefully shutdown the running process
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager shutdown command [command options] [arguments...]
|
forgejo manager shutdown command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1031,10 +1036,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager restart - Gracefully restart the running process - (not implemented for windows servers)
|
forgejo manager restart - Gracefully restart the running process - (not implemented for windows servers)
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager restart command [command options] [arguments...]
|
forgejo manager restart command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1051,10 +1056,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager reload-templates - Reload template files in the running process
|
forgejo manager reload-templates - Reload template files in the running process
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager reload-templates command [command options] [arguments...]
|
forgejo manager reload-templates command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1071,10 +1076,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager flush-queues - Flush queues in the running process
|
forgejo manager flush-queues - Flush queues in the running process
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager flush-queues command [command options] [arguments...]
|
forgejo manager flush-queues command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1093,10 +1098,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging - Adjust logging commands
|
forgejo manager logging - Adjust logging commands
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging command [command options] [arguments...]
|
forgejo manager logging command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
pause Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
|
pause Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
|
||||||
|
@ -1118,10 +1123,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging pause - Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
|
forgejo manager logging pause - Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging pause command [command options] [arguments...]
|
forgejo manager logging pause command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1138,10 +1143,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging resume - Resume logging
|
forgejo manager logging resume - Resume logging
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging resume command [command options] [arguments...]
|
forgejo manager logging resume command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1158,10 +1163,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging release-and-reopen - Cause Forgejo to release and re-open files used for logging
|
forgejo manager logging release-and-reopen - Cause Forgejo to release and re-open files used for logging
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging release-and-reopen command [command options] [arguments...]
|
forgejo manager logging release-and-reopen command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1178,10 +1183,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging remove - Remove a logger
|
forgejo manager logging remove - Remove a logger
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging remove command [command options] [name] Name of logger to remove
|
forgejo manager logging remove command [command options] [name] Name of logger to remove
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1199,10 +1204,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging add - Add a logger
|
forgejo manager logging add - Add a logger
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging add command [command options] [arguments...]
|
forgejo manager logging add command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
file Add a file logger
|
file Add a file logger
|
||||||
|
@ -1220,10 +1225,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging add file - Add a file logger
|
forgejo manager logging add file - Add a file logger
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging add file command [command options] [arguments...]
|
forgejo manager logging add file command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1255,10 +1260,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging add conn - Add a net conn logger
|
forgejo manager logging add conn - Add a net conn logger
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging add conn command [command options] [arguments...]
|
forgejo manager logging add conn command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1287,10 +1292,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager logging log-sql - Set LogSQL
|
forgejo manager logging log-sql - Set LogSQL
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager logging log-sql command [command options] [arguments...]
|
forgejo manager logging log-sql command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1308,10 +1313,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo manager processes - Display running processes within the current process
|
forgejo manager processes - Display running processes within the current process
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo manager processes command [command options] [arguments...]
|
forgejo manager processes command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1333,10 +1338,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo embedded - Extract embedded resources
|
forgejo embedded - Extract embedded resources
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo embedded command [command options] [arguments...]
|
forgejo embedded command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
A command for extracting embedded resources, like templates and images
|
A command for extracting embedded resources, like templates and images
|
||||||
|
@ -1358,10 +1363,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo embedded list - List files matching the given pattern
|
forgejo embedded list - List files matching the given pattern
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo embedded list command [command options] [arguments...]
|
forgejo embedded list command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1378,10 +1383,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo embedded view - View a file matching the given pattern
|
forgejo embedded view - View a file matching the given pattern
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo embedded view command [command options] [arguments...]
|
forgejo embedded view command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1398,10 +1403,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo embedded extract - Extract resources
|
forgejo embedded extract - Extract resources
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo embedded extract command [command options] [arguments...]
|
forgejo embedded extract command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
@ -1422,10 +1427,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo migrate-storage - Migrate the storage
|
forgejo migrate-storage - Migrate the storage
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo migrate-storage command [command options] [arguments...]
|
forgejo migrate-storage command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
Copies stored files from storage configured in app.ini to parameter-configured storage
|
Copies stored files from storage configured in app.ini to parameter-configured storage
|
||||||
|
@ -1456,10 +1461,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo dump-repo - Dump the repository from git/github/gitea/gitlab
|
forgejo dump-repo - Dump the repository from git/github/gitea/gitlab
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo dump-repo command [command options] [arguments...]
|
forgejo dump-repo command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
This is a command for dumping the repository data.
|
This is a command for dumping the repository data.
|
||||||
|
@ -1488,10 +1493,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo restore-repo - Restore the repository from disk
|
forgejo restore-repo - Restore the repository from disk
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo restore-repo command [command options] [arguments...]
|
forgejo restore-repo command [command options]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
This is a command for restoring the repository data.
|
This is a command for restoring the repository data.
|
||||||
|
@ -1516,10 +1521,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo cert - Generate self-signed certificate
|
forgejo cert - Generate self-signed certificate
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo cert [command options] [arguments...]
|
forgejo cert [command options] [arguments...]
|
||||||
|
|
||||||
DESCRIPTION:
|
DESCRIPTION:
|
||||||
Generate a self-signed X.509 certificate for a TLS server.
|
Generate a self-signed X.509 certificate for a TLS server.
|
||||||
|
@ -1539,10 +1544,10 @@ OPTIONS:
|
||||||
|
|
||||||
```
|
```
|
||||||
NAME:
|
NAME:
|
||||||
Forgejo generate secret - Generate a secret token
|
forgejo generate secret - Generate a secret token
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
Forgejo generate secret command [command options] [arguments...]
|
forgejo generate secret command [command options]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
INTERNAL_TOKEN Generate a new INTERNAL_TOKEN
|
INTERNAL_TOKEN Generate a new INTERNAL_TOKEN
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Configuration Cheat Sheet'
|
title: 'Configuration Cheat Sheet'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/config-cheat-sheet.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/config-cheat-sheet.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
This is a cheat sheet for the Forgejo configuration file. It contains most of the settings
|
This is a cheat sheet for the Forgejo configuration file. It contains most of the settings
|
||||||
|
@ -209,7 +209,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
||||||
- `CODE_COMMENT_LINES`: **4**: Number of line of codes shown for a code comment.
|
- `CODE_COMMENT_LINES`: **4**: Number of line of codes shown for a code comment.
|
||||||
- `DEFAULT_THEME`: **forgejo-auto**: \[forgejo-auto, forgejo-light, forgejo-dark, auto, gitea, arc-green\]: Set the default theme for the Forgejo install.
|
- `DEFAULT_THEME`: **forgejo-auto**: \[forgejo-auto, forgejo-light, forgejo-dark, auto, gitea, arc-green\]: Set the default theme for the Forgejo install.
|
||||||
- `SHOW_USER_EMAIL`: **true**: Whether the email of the user should be shown in the Explore Users page.
|
- `SHOW_USER_EMAIL`: **true**: Whether the email of the user should be shown in the Explore Users page.
|
||||||
- `THEMES`: **forgejo-auto,forgejo-light,forgejo-dark,auto,gitea,arc-green**: All available themes. Allow users select personalized themes.
|
- `THEMES`: **forgejo-auto, forgejo-light, forgejo-dark, gitea-auto, gitea-light, gitea-dark, forgejo-auto-deuteranopia-protanopia, forgejo-light-deuteranopia-protanopia, forgejo-dark-deuteranopia-protanopia, forgejo-auto-tritanopia, forgejo-light-tritanopia, forgejo-dark-tritanopia**: All available themes. Allow users select personalized themes.
|
||||||
regardless of the value of `DEFAULT_THEME`.
|
regardless of the value of `DEFAULT_THEME`.
|
||||||
- `MAX_DISPLAY_FILE_SIZE`: **8388608**: Max size of files to be displayed (default is 8MiB)
|
- `MAX_DISPLAY_FILE_SIZE`: **8388608**: Max size of files to be displayed (default is 8MiB)
|
||||||
- `REACTIONS`: All available reactions users can choose on issues/prs and comments
|
- `REACTIONS`: All available reactions users can choose on issues/prs and comments
|
||||||
|
@ -509,8 +509,14 @@ And the following unique queues:
|
||||||
|
|
||||||
- `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: Default configuration for email notifications for users (user configurable). Options: enabled, onmention, disabled
|
- `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: Default configuration for email notifications for users (user configurable). Options: enabled, onmention, disabled
|
||||||
- `DISABLE_REGULAR_ORG_CREATION`: **false**: Disallow regular (non-admin) users from creating organizations.
|
- `DISABLE_REGULAR_ORG_CREATION`: **false**: Disallow regular (non-admin) users from creating organizations.
|
||||||
- `USER_DISABLED_FEATURES`: **_empty_** Disabled features for users, could be `deletion` and more features can be added in future.
|
- `USER_DISABLED_FEATURES`: **_empty_** Disabled features for users, could be `deletion`, `manage_ssh_keys`, `manage_gpg_keys` and more features can be added in future.
|
||||||
- `deletion`: User cannot delete their own account.
|
- `deletion`: User cannot delete their own account.
|
||||||
|
- `manage_ssh_keys`: User cannot configure ssh keys.
|
||||||
|
- `manage_gpg_keys`: User cannot configure gpg keys.
|
||||||
|
- `EXTERNAL_USER_DISABLE_FEATURES`: **_empty_**: Comma separated list of disabled features ONLY if the user has an external login type (eg. LDAP, Oauth, etc.), could be `deletion`, `manage_ssh_keys`, `manage_gpg_keys`. This setting is independent from `USER_DISABLED_FEATURES` and supplements its behavior.
|
||||||
|
- `deletion`: User cannot delete their own account.
|
||||||
|
- `manage_ssh_keys`: User cannot configure ssh keys.
|
||||||
|
- `manage_gpg_keys`: User cannot configure gpg keys.
|
||||||
- `SEND_NOTIFICATION_EMAIL_ON_NEW_USER`: **false**: enable email notifications to instance admins on new user sign-up. It requires `ENABLE_NOTIFY_MAIL` to be true.
|
- `SEND_NOTIFICATION_EMAIL_ON_NEW_USER`: **false**: enable email notifications to instance admins on new user sign-up. It requires `ENABLE_NOTIFY_MAIL` to be true.
|
||||||
|
|
||||||
## Security (`security`)
|
## Security (`security`)
|
||||||
|
@ -518,7 +524,7 @@ And the following unique queues:
|
||||||
- `INSTALL_LOCK`: **false**: Controls access to the installation page. When set to "true", the installation page is not accessible.
|
- `INSTALL_LOCK`: **false**: Controls access to the installation page. When set to "true", the installation page is not accessible.
|
||||||
- `SECRET_KEY`: **\<random at every install\>**: Global secret key. This key is VERY IMPORTANT, if you lost it, the data encrypted by it (like 2FA secret) can't be decrypted anymore.
|
- `SECRET_KEY`: **\<random at every install\>**: Global secret key. This key is VERY IMPORTANT, if you lost it, the data encrypted by it (like 2FA secret) can't be decrypted anymore.
|
||||||
- `SECRET_KEY_URI`: **\<empty\>**: Instead of defining SECRET_KEY, this option can be used to use the key stored in a file (example value: `file:/etc/forgejo/secret_key`). It shouldn't be lost like SECRET_KEY.
|
- `SECRET_KEY_URI`: **\<empty\>**: Instead of defining SECRET_KEY, this option can be used to use the key stored in a file (example value: `file:/etc/forgejo/secret_key`). It shouldn't be lost like SECRET_KEY.
|
||||||
- `LOGIN_REMEMBER_DAYS`: **7**: Cookie lifetime, in days.
|
- `LOGIN_REMEMBER_DAYS`: **31**: Cookie lifetime, in days.
|
||||||
- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: Name of cookie used to store authentication
|
- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: Name of cookie used to store authentication
|
||||||
information.
|
information.
|
||||||
- `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: Header name for reverse proxy
|
- `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: Header name for reverse proxy
|
||||||
|
@ -580,7 +586,7 @@ And the following unique queues:
|
||||||
|
|
||||||
## OpenID (`openid`)
|
## OpenID (`openid`)
|
||||||
|
|
||||||
- `ENABLE_OPENID_SIGNIN`: **false**: Allow authentication in via OpenID.
|
- `ENABLE_OPENID_SIGNIN`: **true**: Allow authentication in via OpenID.
|
||||||
- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: Allow registering via OpenID.
|
- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: Allow registering via OpenID.
|
||||||
- `WHITELISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
|
- `WHITELISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
|
||||||
OpenID URI's to permit.
|
OpenID URI's to permit.
|
||||||
|
@ -816,7 +822,7 @@ Default templates for project boards:
|
||||||
## Issue and pull request attachments (`attachment`)
|
## Issue and pull request attachments (`attachment`)
|
||||||
|
|
||||||
- `ENABLED`: **true**: Whether issue and pull request attachments are enabled.
|
- `ENABLED`: **true**: Whether issue and pull request attachments are enabled.
|
||||||
- `ALLOWED_TYPES`: **.csv,.docx,.fodg,.fodp,.fods,.fodt,.gif,.gz,.jpeg,.jpg,.log,.md,.mov,.mp4,.odf,.odg,.odp,.ods,.odt,.patch,.pdf,.png,.pptx,.svg,.tgz,.txt,.webm,.xls,.xlsx,.zip**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
|
- `ALLOWED_TYPES`: **.cpuprofile,.csv,.dmp,.docx,.fodg,.fodp,.fods,.fodt,.gif,.gz,.jpeg,.jpg,.json,.jsonc,.log,.md,.mov,.mp4,.odf,.odg,.odp,.ods,.odt,.patch,.pdf,.png,.pptx,.svg,.tgz,.txt,.webm,.xls,.xlsx,.zip**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
|
||||||
- `MAX_SIZE`: **4**: Maximum size (MB).
|
- `MAX_SIZE`: **4**: Maximum size (MB).
|
||||||
- `MAX_FILES`: **5**: Maximum number of attachments that can be uploaded at once.
|
- `MAX_FILES`: **5**: Maximum number of attachments that can be uploaded at once.
|
||||||
|
|
||||||
|
@ -1177,14 +1183,6 @@ If the rule is defined above the renderer ini section or the name does not match
|
||||||
|
|
||||||
- `DEFAULT_UI_LOCATION`: Default location of time on the UI, so that we can display correct user's time on UI. i.e. Asia/Shanghai
|
- `DEFAULT_UI_LOCATION`: Default location of time on the UI, so that we can display correct user's time on UI. i.e. Asia/Shanghai
|
||||||
|
|
||||||
## Task (`task`)
|
|
||||||
|
|
||||||
Task queue configuration has been moved to `queue.task`. However, the below configuration values are kept for backwards compatibility:
|
|
||||||
|
|
||||||
- `QUEUE_TYPE`: **channel**: Task queue type, could be `channel` or `redis`.
|
|
||||||
- `QUEUE_LENGTH`: **1000**: Task queue length, available only when `QUEUE_TYPE` is `channel`.
|
|
||||||
- `QUEUE_CONN_STR`: **redis://127.0.0.1:6379/0**: Task queue connection string, available only when `QUEUE_TYPE` is `redis`. If redis needs a password, use `redis://123@127.0.0.1:6379/0` or `redis+cluster://123@127.0.0.1:6379/0`.
|
|
||||||
|
|
||||||
## Migrations (`migrations`)
|
## Migrations (`migrations`)
|
||||||
|
|
||||||
- `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations.
|
- `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations.
|
||||||
|
@ -1302,11 +1300,12 @@ PROXY_HOSTS = *.github.com
|
||||||
- `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time.
|
- `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time.
|
||||||
- `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time.
|
- `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time.
|
||||||
- `ABANDONED_JOB_TIMEOUT`: **24h**: Timeout to cancel the jobs which have waiting status, but haven't been picked by a runner for a long time.
|
- `ABANDONED_JOB_TIMEOUT`: **24h**: Timeout to cancel the jobs which have waiting status, but haven't been picked by a runner for a long time.
|
||||||
- `SKIP_WORKFLOW_STRINGS`: **[skip ci],[ci skip],[no ci],[skip actions],[actions skip]**: Strings committers can place inside a commit message to skip executing the corresponding actions workflow
|
- `SKIP_WORKFLOW_STRINGS`: **[skip ci],[ci skip],[no ci],[skip actions],[actions skip]**: Strings committers can place inside a commit message or pull request title to skip executing the corresponding actions workflow
|
||||||
|
|
||||||
## Other (`other`)
|
## Other (`other`)
|
||||||
|
|
||||||
- `SHOW_FOOTER_VERSION`: **true**: Show Forgejo and Go version information in the footer.
|
- `SHOW_FOOTER_VERSION`: **true**: Show Forgejo and Go version information in the footer.
|
||||||
- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.
|
- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.
|
||||||
|
- `SHOW_FOOTER_POWERED_BY`: **true**: Show the "powered by" text in the footer.
|
||||||
- `ENABLE_SITEMAP`: **true**: Generate sitemap.
|
- `ENABLE_SITEMAP`: **true**: Generate sitemap.
|
||||||
- `ENABLE_FEED`: **true**: Enable/Disable RSS/Atom feed.
|
- `ENABLE_FEED`: **true**: Enable/Disable RSS/Atom feed.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Database Preparation'
|
title: 'Database Preparation'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/installation/database-preparation.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/installation/database-preparation.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
You need a database to use Forgejo. Forgejo supports PostgreSQL (>=12), MySQL (>=8.0) or MariaDB (>=10.0), and SQLite (builtin). This page will guide into preparing the database. Only PostgreSQL and MySQL/MariaDB will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter.
|
You need a database to use Forgejo. Forgejo supports PostgreSQL (>=12), MySQL (>=8.0) or MariaDB (>=10.0), and SQLite (builtin). This page will guide into preparing the database. Only PostgreSQL and MySQL/MariaDB will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Email setup'
|
title: 'Email setup'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/email-setup.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/email-setup.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo can be set to send emails such as a registration confirmation, either with [Sendmail](https://man7.org/linux/man-pages/man8/sendmail.8.html) (or compatible MTAs like Postfix and msmtp) or by connecting to an SMTP server.
|
Forgejo can be set to send emails such as a registration confirmation, either with [Sendmail](https://man7.org/linux/man-pages/man8/sendmail.8.html) (or compatible MTAs like Postfix and msmtp) or by connecting to an SMTP server.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Incoming Email'
|
title: 'Incoming Email'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/incoming-email.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/incoming-email.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo supports the execution of several actions through incoming mails. This page describes how to set this up.
|
Forgejo supports the execution of several actions through incoming mails. This page describes how to set this up.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Logging Configuration'
|
title: 'Logging Configuration'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/logging-config.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/logging-config.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
The logging configuration of Forgejo mainly consists of 3 types of components:
|
The logging configuration of Forgejo mainly consists of 3 types of components:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Reverse proxy'
|
title: 'Reverse proxy'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/authentication.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/authentication.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with
|
Forgejo supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Search Engines Indexation'
|
title: 'Search Engines Indexation'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/search-engines-indexation.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/search-engines-indexation.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## Search engines indexation of your Forgejo installation
|
## Search engines indexation of your Forgejo installation
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Seek Assistance'
|
title: 'Seek Assistance'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/help/seek-help.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/help/seek-help.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
- [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org)
|
- [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org)
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'GPG Commit Signatures'
|
title: 'GPG Commit Signatures'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/signing.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/signing.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo will verify GPG commit signatures in the provided tree by
|
Forgejo will verify GPG commit signatures in the provided tree by
|
||||||
|
|
|
@ -95,10 +95,16 @@ The database version is stored in the database and used to prevent an accidental
|
||||||
- Any version before [Gitea 1.17](https://github.com/go-gitea/gitea/releases/tag/v1.17.4)
|
- Any version before [Gitea 1.17](https://github.com/go-gitea/gitea/releases/tag/v1.17.4)
|
||||||
- preserve a custom gitconfig: [episode 1](https://web.archive.org/web/20240313092747/https://gna.org/blog/1-17-breaking-episode-1/), [episode 2](https://web.archive.org/web/20240313092759/https://gna.org/blog/1-17-breaking-episode-2/)
|
- preserve a custom gitconfig: [episode 1](https://web.archive.org/web/20240313092747/https://gna.org/blog/1-17-breaking-episode-1/), [episode 2](https://web.archive.org/web/20240313092759/https://gna.org/blog/1-17-breaking-episode-2/)
|
||||||
- [Gitea 1.13.0](https://blog.gitea.io/2020/12/gitea-1.13.0-is-released/)
|
- [Gitea 1.13.0](https://blog.gitea.io/2020/12/gitea-1.13.0-is-released/)
|
||||||
|
|
||||||
- The Webhook shared secret inside the webhook payload has been deprecated and will be removed in 1.14.0: https://github.com/go-gitea/gitea/issues/11755 please use the secret header that uses an hmac signature to validate the webhook payload.
|
- The Webhook shared secret inside the webhook payload has been deprecated and will be removed in 1.14.0: https://github.com/go-gitea/gitea/issues/11755 please use the secret header that uses an hmac signature to validate the webhook payload.
|
||||||
- Git hooks now default to `off`! ([#13058](https://github.com/go-gitea/gitea/pull/13058))
|
- Git hooks now default to `off`! ([#13058](https://github.com/go-gitea/gitea/pull/13058))
|
||||||
In your config, you can check the security section for `DISABLE_GIT_HOOKS`. To enable them again, you must set the setting to `false`.
|
In your config, you can check the security section for `DISABLE_GIT_HOOKS`. To enable them again, you must set the setting to `false`.
|
||||||
|
|
||||||
|
- From an instance originally installed with gogs, even if migrated later to Gitea or Forgejo because database columns are not automatically removed by migrations.
|
||||||
|
- Drop the `created` column from the `issue` table while Forgejo is not running. It will be re-created:
|
||||||
|
- SQLite `ALTER TABLE `issue`DROP`created``
|
||||||
|
- MySQL/MariaDB/PostgreSQL `ALTER TABLE `issue`DROP COLUMN`created``
|
||||||
|
|
||||||
### Only when upgrading to a specific version
|
### Only when upgrading to a specific version
|
||||||
|
|
||||||
- From [v1.19] to a version greater or equal to than [1.20](https://forgejo.org/2023-07-release-v1/)
|
- From [v1.19] to a version greater or equal to than [1.20](https://forgejo.org/2023-07-release-v1/)
|
||||||
|
|
|
@ -8,16 +8,16 @@ license: 'CC-BY-SA-4.0'
|
||||||
Forgejo stable releases are published on a fixed schedule, every quarter.
|
Forgejo stable releases are published on a fixed schedule, every quarter.
|
||||||
|
|
||||||
| **Date** | **Version** | **Release date** | **End Of Life** |
|
| **Date** | **Version** | **Release date** | **End Of Life** |
|
||||||
| -------- | ---------------------- | ---------------- | ---------------- |
|
| -------- | ------------------------ | ---------------- | ---------------- |
|
||||||
| 2024 Q1 | 7.0.0+LTS-gitea-1.22.0 | 23 April 2024 | **16 July 2025** |
|
| 2024 Q1 | 7.0.0+gitea-1.22.0 (LTS) | 23 April 2024 | **16 July 2025** |
|
||||||
| 2024 Q2 | X.Y.Z+gitea-A.B.C | 17 July 2024 | 16 October 2024 |
|
| 2024 Q2 | 8.0.0+gitea-A.B.C | 17 July 2024 | 16 October 2024 |
|
||||||
| 2024 Q3 | X.Y.Z+gitea-A.B.C | 16 October 2024 | 15 January 2025 |
|
| 2024 Q3 | X.Y.Z+gitea-A.B.C | 16 October 2024 | 15 January 2025 |
|
||||||
| 2024 Q4 | X.Y.Z+gitea-A.B.C | 15 January 2025 | 16 April 2025 |
|
| 2024 Q4 | X.Y.Z+gitea-A.B.C | 15 January 2025 | 16 April 2025 |
|
||||||
| 2025 Q1 | X.Y.Z+LTS-gitea-A.B.C | 16 April 2025 | **14 July 2026** |
|
| 2025 Q1 | X.Y.Z+gitea-A.B.C (LTS) | 16 April 2025 | **14 July 2026** |
|
||||||
| 2025 Q2 | X.Y.Z+gitea-A.B.C | 16 July 2025 | 15 October 2025 |
|
| 2025 Q2 | X.Y.Z+gitea-A.B.C | 16 July 2025 | 15 October 2025 |
|
||||||
| 2025 Q3 | X.Y.Z+gitea-A.B.C | 15 October 2025 | 14 January 2026 |
|
| 2025 Q3 | X.Y.Z+gitea-A.B.C | 15 October 2025 | 14 January 2026 |
|
||||||
| 2025 Q4 | X.Y.Z+gitea-A.B.C | 14 January 2026 | 15 April 2026 |
|
| 2025 Q4 | X.Y.Z+gitea-A.B.C | 14 January 2026 | 15 April 2026 |
|
||||||
| 2026 Q1 | X.Y.Z+LTS-gitea-A.B.C | 15 April 2026 | **14 July 2027** |
|
| 2026 Q1 | X.Y.Z+gitea-A.B.C (LTS) | 15 April 2026 | **14 July 2027** |
|
||||||
| 2026 Q2 | X.Y.Z+gitea-A.B.C | 15 July 2026 | 14 October 2026 |
|
| 2026 Q2 | X.Y.Z+gitea-A.B.C | 15 July 2026 | 14 October 2026 |
|
||||||
|
|
||||||
### Stable release support
|
### Stable release support
|
||||||
|
@ -42,14 +42,11 @@ The Forgejo release numbers are compliant with [Semantic Versioning](https://sem
|
||||||
|
|
||||||
- Forgejo **v7.1.0+gitea-1.22.0** is compatible with Gitea **v1.22.0**.
|
- Forgejo **v7.1.0+gitea-1.22.0** is compatible with Gitea **v1.22.0**.
|
||||||
|
|
||||||
Long term support releases have the `LTS` string in their metadata. For instance:
|
The release candidates are built of the stable branch and published with the **-test** suffix:
|
||||||
|
|
||||||
- Forgejo **v7.0.0+LTS-gitea-1.22.0** is a long term support release compatible with Gitea **v1.22.0**.
|
- Forgejo **v7.0-test**
|
||||||
|
- Forgejo **v8.0-test**
|
||||||
The release candidates are composed by adding the `-rc` suffix. For instance:
|
- Forgejo **v8.1-test**
|
||||||
|
|
||||||
- Forgejo **v7.1.0-rc0+gitea-1.22.0**
|
|
||||||
- Forgejo **v7.1.0-rc1+gitea-1.22.0**
|
|
||||||
- etc.
|
- etc.
|
||||||
|
|
||||||
## Stable release process
|
## Stable release process
|
||||||
|
@ -150,8 +147,8 @@ The release is built on https://code.forgejo.org/forgejo-integration/runner, whi
|
||||||
|
|
||||||
The release is published on
|
The release is published on
|
||||||
https://forgejo.octopuce.forgejo.org/forgejo/runner, which is a mirror
|
https://forgejo.octopuce.forgejo.org/forgejo/runner, which is a mirror
|
||||||
of https://code.forgejo.org/forgejo-integration/runner. It is behind a
|
of https://code.forgejo.org/forgejo-integration/runner. It has no public IP
|
||||||
VPN and its role is to copy and sign release artifacts.
|
and its role is to copy and sign release artifacts.
|
||||||
|
|
||||||
- Binaries are downloaded from https://code.forgejo.org/forgejo-integration/runner, signed and copied to https://code.forgejo.org/forgejo/runner.
|
- Binaries are downloaded from https://code.forgejo.org/forgejo-integration/runner, signed and copied to https://code.forgejo.org/forgejo/runner.
|
||||||
- Container images are copied from https://code.forgejo.org/forgejo-integration to https://code.forgejo.org/forgejo
|
- Container images are copied from https://code.forgejo.org/forgejo-integration to https://code.forgejo.org/forgejo
|
||||||
|
@ -169,7 +166,7 @@ providing the secrets from the command line.
|
||||||
|
|
||||||
### Securing the release token and cryptographic keys
|
### Securing the release token and cryptographic keys
|
||||||
|
|
||||||
For both the Forgejo runner and Forgejo itself, copying and signing the release artifacts (container images and binaries) happen on a Forgejo isntance running [behind a VPN](../infrastructure/#octopuce) to safeguard the token that has write access to the Forgejo repository as well as the cryptographic key used to sign the releases.
|
For both the Forgejo runner and Forgejo itself, copying and signing the release artifacts (container images and binaries) happen on a Forgejo instance [not publicly accessible](../infrastructure/#octopuce) to safeguard the token that has write access to the Forgejo repository as well as the cryptographic key used to sign the releases.
|
||||||
|
|
||||||
### Website update
|
### Website update
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Interface customization'
|
title: 'Interface customization'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/customizing-gitea.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/customizing-gitea.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
This sections documents the Forgejo interface customization that requires an intimate knowledge of the underlying codebase. The user interface customization documented and supported for Forgejo admins to use [is found in the corresponding administrator guide section](../../admin/customization/).
|
This sections documents the Forgejo interface customization that requires an intimate knowledge of the underlying codebase. The user interface customization documented and supported for Forgejo admins to use [is found in the corresponding administrator guide section](../../admin/customization/).
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Compiling from source'
|
title: 'Compiling from source'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/installation/from-source.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/installation/from-source.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation from source
|
## Installation from source
|
||||||
|
@ -102,11 +102,11 @@ TAGS="bindata" make build
|
||||||
```
|
```
|
||||||
|
|
||||||
In the default release build of the continuous integration system, the build
|
In the default release build of the continuous integration system, the build
|
||||||
tags are: `TAGS="bindata sqlite sqlite_unlock_notify"`. The simplest
|
tags are: `TAGS="bindata timetzdata sqlite sqlite_unlock_notify"`. The simplest
|
||||||
recommended way to build from source is therefore:
|
recommended way to build from source is therefore:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
TAGS="bindata sqlite sqlite_unlock_notify" make build
|
TAGS="bindata timetzdata sqlite sqlite_unlock_notify" make build
|
||||||
```
|
```
|
||||||
|
|
||||||
The `build` target is split into two sub-targets:
|
The `build` target is split into two sub-targets:
|
||||||
|
@ -136,4 +136,4 @@ You can also supply a tag during the build process with the `-t` option, to make
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
See [the section dedicated to testing](./testing/).
|
See [the section dedicated to testing](../testing/).
|
||||||
|
|
|
@ -267,6 +267,8 @@ IP allocated to the LXC container running the web service:
|
||||||
|
|
||||||
```
|
```
|
||||||
server {
|
server {
|
||||||
|
listen 80;
|
||||||
|
listen [::]:80;
|
||||||
|
|
||||||
server_name code.forgejo.org;
|
server_name code.forgejo.org;
|
||||||
|
|
||||||
|
@ -319,6 +321,8 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
|
||||||
bash -x /home/debian/run-forgejo.sh
|
bash -x /home/debian/run-forgejo.sh
|
||||||
docker logs -n 200 -f forgejo
|
docker logs -n 200 -f forgejo
|
||||||
```
|
```
|
||||||
|
- Rotating 30 days backups happen daily `/etc/cron.daily/forgejo-code-backup.sh`
|
||||||
|
- Add code.forgejo.org to the forgejo.org SPF record
|
||||||
|
|
||||||
- `forgejo-next` on hetzner02
|
- `forgejo-next` on hetzner02
|
||||||
|
|
||||||
|
@ -335,7 +339,6 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
|
||||||
sudo mv /srv/forgejo /srv/forgejo.old
|
sudo mv /srv/forgejo /srv/forgejo.old
|
||||||
bash -x /home/debian/run-forgejo.sh
|
bash -x /home/debian/run-forgejo.sh
|
||||||
```
|
```
|
||||||
and create a user with the CLI using the example from `/home/debian/run-forgejo.sh`
|
|
||||||
- `/home/debian/next.nftables`
|
- `/home/debian/next.nftables`
|
||||||
```
|
```
|
||||||
add table ip next;
|
add table ip next;
|
||||||
|
@ -346,9 +349,49 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
|
||||||
ip daddr 65.21.67.65 tcp dport { 2020 } dnat to 10.6.83.213;
|
ip daddr 65.21.67.65 tcp dport { 2020 } dnat to 10.6.83.213;
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
- Add to `iface enp5s0 inet static` in `/etc/network/interfaces`
|
||||||
|
```
|
||||||
|
up nft -f /home/debian/next.nftables
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
- `/etc/nginx/sites-available/next.forgejo.org` same as `/etc/nginx/sites-available/code.forgejo.org`
|
- `/etc/nginx/sites-available/next.forgejo.org` same as `/etc/nginx/sites-available/code.forgejo.org`
|
||||||
|
|
||||||
Rotating 30 days backups happen daily `/etc/cron.daily/forgejo-code-backup.sh`
|
```
|
||||||
|
|
||||||
|
- `forgejo-v7` on hetzner02
|
||||||
|
|
||||||
|
Dedicated to https://v7.next.forgejo.org
|
||||||
|
|
||||||
|
- LXC creation same as code.forgejo.org
|
||||||
|
- `/etc/cron.hourly/forgejo-upgrade` runs `/home/debian/run-forgejo.sh > /home/debian/run-forgejo-$(date +%d).log`
|
||||||
|
- Reset everything
|
||||||
|
```sh
|
||||||
|
docker stop forgejo
|
||||||
|
docker rm forgejo
|
||||||
|
sudo rm -fr /srv/forgejo.old
|
||||||
|
sudo mv /srv/forgejo /srv/forgejo.old
|
||||||
|
bash -x /home/debian/run-forgejo.sh
|
||||||
|
```
|
||||||
|
- `/home/debian/v7.nftables`
|
||||||
|
```
|
||||||
|
add table ip v7;
|
||||||
|
flush table ip v7;
|
||||||
|
add chain ip v7 prerouting {
|
||||||
|
type nat hook prerouting priority 0;
|
||||||
|
policy accept;
|
||||||
|
ip daddr 65.21.67.65 tcp dport { 2070 } dnat to 10.6.83.179;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
- Add to `iface enp5s0 inet static` in `/etc/network/interfaces`
|
||||||
|
```
|
||||||
|
up nft -f /home/debian/v7.nftables
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
- `/etc/nginx/sites-available/v7.forgejo.org` same as `/etc/nginx/sites-available/code.forgejo.org`
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
- `runner-forgejo-helm` on hetzner03
|
- `runner-forgejo-helm` on hetzner03
|
||||||
|
|
||||||
|
|
|
@ -13,16 +13,20 @@ Weblate is [configured to propose pull requests](https://translate.codeberg.org/
|
||||||
to the Forgejo repository with new translations. These pull requests should be **squash merged** into the Forgejo
|
to the Forgejo repository with new translations. These pull requests should be **squash merged** into the Forgejo
|
||||||
development branch as follows:
|
development branch as follows:
|
||||||
|
|
||||||
- announce 15 minutes before in the chatroom `@room the translations will be locked for maintenance in 15 minutes, make sure you don't try to save a translation when that happens as it will be lost.`
|
- announce in the chatroom: `@room the translations will be locked for maintenance in about 15 minutes. Make sure you don't try to save a translation when that happens as it will be lost.`
|
||||||
- go to the [Weblate repository admin page](https://translate.codeberg.org/projects/forgejo/forgejo/#repository)
|
- go to the [Weblate repository admin page](https://translate.codeberg.org/projects/forgejo/forgejo/#repository)
|
||||||
- click lock
|
- click `Commit`. This is done optionally to make tests run before interrupting anyone, to reduce the total maintenance time
|
||||||
|
- post an [announcement in Weblate](https://translate.codeberg.org/projects/forgejo/#announcement): `The translations will be locked for maintenance soon. Make sure you don't try to save a translation when that happens as it will be lost.`
|
||||||
|
- wait 15 minutes
|
||||||
|
- click `Lock`
|
||||||
- reload the page
|
- reload the page
|
||||||
- check the number of commits
|
- check the number of commits
|
||||||
- verify there are 0 pending changes
|
- verify there are 0 pending changes
|
||||||
- go to the pull request and wait until it is rebased and has the same number of commits
|
- go to the pull request and wait until it is rebased and has the same number of commits
|
||||||
- squash merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
|
- squash-merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
|
||||||
- click reset
|
- click `Reset`
|
||||||
- click unlock
|
- click `Unlock`
|
||||||
|
- remove Weblate announcement
|
||||||
|
|
||||||
## Merging a pull request that changes translations
|
## Merging a pull request that changes translations
|
||||||
|
|
||||||
|
@ -34,5 +38,5 @@ are merged as explained above. Only the end of the sequence changes:
|
||||||
|
|
||||||
- squash merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
|
- squash merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
|
||||||
- merge the PR (after resolving conflicts due to the merge of the Weblate changes)
|
- merge the PR (after resolving conflicts due to the merge of the Weblate changes)
|
||||||
- click reset
|
- click `Reset`
|
||||||
- click unlock
|
- click `Unlock`
|
||||||
|
|
|
@ -7,20 +7,10 @@ _This is the developer documentation for Forgejo Next, covering technical
|
||||||
details for Forgejo contributors.
|
details for Forgejo contributors.
|
||||||
[Go to end-user documentation for service overview.](../../user/forgejo-next/)_
|
[Go to end-user documentation for service overview.](../../user/forgejo-next/)_
|
||||||
|
|
||||||
https://next.forgejo.org, also known as Forgejo Next, is Forgejo's
|
The Forgejo instances running under the `next.forgejo.org` domain are official testing and demonstration instance. They are updated daily. The data they contain may be wiped out without notice.
|
||||||
official testing and demonstration instance. The specific version of
|
|
||||||
Forgejo running on this instance varies depending on the status of the
|
|
||||||
latest release branch.
|
|
||||||
|
|
||||||
Typically, the instance will be running the daily build straight from the
|
- https://next.forgejo.org runs the tip of the [forgejo branch](https://codeberg.org/forgejo/forgejo/src/branch/forgejo).
|
||||||
`forgejo` branch, meaning it contains experimental code that will be
|
- https://v7.next.forgejo.org runs from the [codeberg.org/forgejo-experimental/forgejo:7](https://codeberg.org/forgejo-experimental/-/packages/container/forgejo/7) OCI image. It is built from the latest commit of the most recent branch.
|
||||||
included in the next major version of Forgejo.
|
|
||||||
|
|
||||||
When a release branch is created and release candidates are posted,
|
For details on the hardware from which it is running, [checkout the section in the
|
||||||
Forgejo Next will be switched to the latest release candidate. Release
|
|
||||||
candidates are to be deployed until a stable release is
|
|
||||||
available. next.forgejo.org will then be upgraded back to the
|
|
||||||
`forgejo` branch.
|
|
||||||
|
|
||||||
For details on the hardward from which it is running, [checkout the section in the
|
|
||||||
infrastructe documentation](../infrastructure/#containers).
|
infrastructe documentation](../infrastructure/#containers).
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: 'Forgejo v1.21 documentation'
|
title: 'Forgejo v7.0 documentation'
|
||||||
---
|
---
|
||||||
|
|
||||||
- [What is Forgejo?](/)
|
- [What is Forgejo?](/)
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'AGit Workflow Usage'
|
title: 'AGit Workflow Usage'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/agit-support.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/agit-support.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo ships with limited support for [AGit-Flow](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/). It was originally introduced in Gitea `1.13`.
|
Forgejo ships with limited support for [AGit-Flow](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/). It was originally introduced in Gitea `1.13`.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'API Usage'
|
title: 'API Usage'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/development/api-usage.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/development/api-usage.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
The Forgejo API for all versions that have the same major number
|
The Forgejo API for all versions that have the same major number
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Authentication'
|
title: 'Authentication'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/authentication.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/authentication.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## LDAP (Lightweight Directory Access Protocol)
|
## LDAP (Lightweight Directory Access Protocol)
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Blame File View'
|
title: 'Blame File View'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/blame.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/blame.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo supports viewing the line-by-line revision history for a file also known as blame view.
|
Forgejo supports viewing the line-by-line revision history for a file also known as blame view.
|
||||||
|
|
18
docs/user/incoming.md
Normal file
18
docs/user/incoming.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
title: Comment on issues and pull requests via email
|
||||||
|
license: 'CC-BY-SA-4.0'
|
||||||
|
---
|
||||||
|
|
||||||
|
> **NOTE:** this feature is not enabled by default, the [`[email.incoming].ENABLED`](../../admin/config-cheat-sheet/) setting must be set.
|
||||||
|
|
||||||
|
When receiving a notification it is possible to reply to the email instead of using the web interface. The content of the reply will be stripped of the quoted text (lines starting with greater than `>`) and used as the content of the comment. The attachments from the reply will be added as attachments to the comment.
|
||||||
|
|
||||||
|
It will be taken into account when receiving a notification email about:
|
||||||
|
|
||||||
|
- A newly created issue
|
||||||
|
- A newly created pull request
|
||||||
|
- A comment added to a specific line of code in a pull request review
|
||||||
|
- A comment to an existing issue
|
||||||
|
- A comment to an existing pull request
|
||||||
|
|
||||||
|
> **NOTE:** the reply address contains a unique token to match the response with the issue or pull request and looks like this: `forgejo+ABCDE@example.com`. In some mail clients, such as Thunderbird, using this reply address may require using the `Reply List` button rather than the `Reply` button.
|
|
@ -32,6 +32,7 @@ involved in running it on their machines.
|
||||||
- [README badges](./readme-badges/)
|
- [README badges](./readme-badges/)
|
||||||
- Advanced Usage
|
- Advanced Usage
|
||||||
- [Issue and Pull Request Templates](./issue-pull-request-templates/)
|
- [Issue and Pull Request Templates](./issue-pull-request-templates/)
|
||||||
|
- [Comment on issues and pull requests via email](./incoming/)
|
||||||
- [Actions](./actions/)
|
- [Actions](./actions/)
|
||||||
- [Merge Message templates](./merge-message-templates/)
|
- [Merge Message templates](./merge-message-templates/)
|
||||||
- [Webhooks](./webhooks/)
|
- [Webhooks](./webhooks/)
|
||||||
|
@ -47,6 +48,7 @@ involved in running it on their machines.
|
||||||
- [Forgejo versions](./versions/)
|
- [Forgejo versions](./versions/)
|
||||||
- [Reference](https://codeberg.org/api/swagger)
|
- [Reference](https://codeberg.org/api/swagger)
|
||||||
- [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)
|
- [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)
|
||||||
|
- [Repository Mirrors](./repo-mirror/)
|
||||||
- [Push to create](./push-to-create/)
|
- [Push to create](./push-to-create/)
|
||||||
- [AGit Workflow Usage](./agit-support/)
|
- [AGit Workflow Usage](./agit-support/)
|
||||||
- [Packages](./packages/)
|
- [Packages](./packages/)
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Issue and Pull Request Templates'
|
title: 'Issue and Pull Request Templates'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/issue-pull-request-templates.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/issue-pull-request-templates.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Some projects have a standard list of questions that users need to answer
|
Some projects have a standard list of questions that users need to answer
|
||||||
|
@ -9,6 +9,7 @@ when creating an issue or pull request. Forgejo supports adding templates to the
|
||||||
**default branch of the repository** so that they can autopopulate the form when users are
|
**default branch of the repository** so that they can autopopulate the form when users are
|
||||||
creating issues and pull requests. This will cut down on the initial back and forth
|
creating issues and pull requests. This will cut down on the initial back and forth
|
||||||
of getting some clarifying details.
|
of getting some clarifying details.
|
||||||
|
It is currently not possible to provide generic issue/pull-request templates globally.
|
||||||
|
|
||||||
Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&body=Issue+Text` and the form will be populated with those strings. Those strings will be used instead of the template if there is one.
|
Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&body=Issue+Text` and the form will be populated with those strings. Those strings will be used instead of the template if there is one.
|
||||||
|
|
||||||
|
@ -119,6 +120,12 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for taking the time to fill out this bug report!
|
Thanks for taking the time to fill out this bug report!
|
||||||
|
# some markdown that will only be visible once the issue has been created
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
This issue was created by an issue **template** :)
|
||||||
|
visible: [content]
|
||||||
- type: input
|
- type: input
|
||||||
id: contact
|
id: contact
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -170,11 +177,16 @@ body:
|
||||||
options:
|
options:
|
||||||
- label: I agree to follow this project's Code of Conduct
|
- label: I agree to follow this project's Code of Conduct
|
||||||
required: true
|
required: true
|
||||||
|
- label: I have also read the CONTRIBUTION.MD
|
||||||
|
required: true
|
||||||
|
visible: [form]
|
||||||
|
- label: This is a TODO only visible after issue creation
|
||||||
|
visible: [content]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Markdown
|
### Markdown
|
||||||
|
|
||||||
You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted.
|
You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted by default.
|
||||||
|
|
||||||
Attributes:
|
Attributes:
|
||||||
|
|
||||||
|
@ -182,6 +194,8 @@ Attributes:
|
||||||
| ----- | ------------------------------------------------------------ | -------- | ------ | ------- | ------------ |
|
| ----- | ------------------------------------------------------------ | -------- | ------ | ------- | ------------ |
|
||||||
| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - |
|
| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - |
|
||||||
|
|
||||||
|
visible: Default is **[form]**
|
||||||
|
|
||||||
### Textarea
|
### Textarea
|
||||||
|
|
||||||
You can use a `textarea` element to add a multi-line text field to your form. Contributors can also attach files in `textarea` fields.
|
You can use a `textarea` element to add a multi-line text field to your form. Contributors can also attach files in `textarea` fields.
|
||||||
|
@ -202,6 +216,8 @@ Validations:
|
||||||
| -------- | ---------------------------------------------------- | -------- | ------- | ------- | ------------ |
|
| -------- | ---------------------------------------------------- | -------- | ------- | ------- | ------------ |
|
||||||
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
||||||
|
|
||||||
|
visible: Default is **[form, content]**
|
||||||
|
|
||||||
### Input
|
### Input
|
||||||
|
|
||||||
You can use an `input` element to add a single-line text field to your form.
|
You can use an `input` element to add a single-line text field to your form.
|
||||||
|
@ -218,10 +234,12 @@ Attributes:
|
||||||
Validations:
|
Validations:
|
||||||
|
|
||||||
| Key | Description | Required | Type | Default | Valid values |
|
| Key | Description | Required | Type | Default | Valid values |
|
||||||
| --------- | ----------------------------------------------------------------------------------------- | -------- | ------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
|
| --------- | ------------------------------------------------------------------------------------------------ | -------- | ------- | ------- | ------------------------------------------------------------------------ |
|
||||||
| required | Prevents form submission if the input is empty. | Optional | Boolean | false | - |
|
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
||||||
| is_number | Prevents form submission if the value of the input is not a number. | Optional | Boolean | false | - |
|
| is_number | Prevents form submission until element is filled with a number. | Optional | Boolean | false | - |
|
||||||
| regex | Prevents form submission if the value of the input does not match the regular expression. | Optional | String | - | a [JavaScript regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) |
|
| regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) |
|
||||||
|
|
||||||
|
visible: Default is **[form, content]**
|
||||||
|
|
||||||
### Dropdown
|
### Dropdown
|
||||||
|
|
||||||
|
@ -242,6 +260,8 @@ Validations:
|
||||||
| -------- | ---------------------------------------------------- | -------- | ------- | ------- | ------------ |
|
| -------- | ---------------------------------------------------- | -------- | ------- | ------- | ------------ |
|
||||||
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
||||||
|
|
||||||
|
visible: Default is **[form, content]**
|
||||||
|
|
||||||
### Checkboxes
|
### Checkboxes
|
||||||
|
|
||||||
You can use the `checkboxes` element to add a set of checkboxes to your form.
|
You can use the `checkboxes` element to add a set of checkboxes to your form.
|
||||||
|
@ -257,9 +277,12 @@ Attributes:
|
||||||
For each value in the options array, you can set the following keys.
|
For each value in the options array, you can set the following keys.
|
||||||
|
|
||||||
| Key | Description | Required | Type | Default | Options |
|
| Key | Description | Required | Type | Default | Options |
|
||||||
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ------- | ------- |
|
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ | ------- | ------- |
|
||||||
| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - |
|
| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - |
|
||||||
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
||||||
|
| visible | Whether a specific checkbox appears in the form only, in the created issue only, or both. Valid options are "form" and "content". | Optional | String array | false | - |
|
||||||
|
|
||||||
|
visible: Default is **[form, content]**
|
||||||
|
|
||||||
## Syntax for issue config
|
## Syntax for issue config
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Labels'
|
title: 'Labels'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/labels.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/labels.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
You can use labels to classify issues and pull requests and to improve your overview over them.
|
You can use labels to classify issues and pull requests and to improve your overview over them.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Automatically Linked References in Issues, Pull Requests and Commit Messages'
|
title: 'Automatically Linked References in Issues, Pull Requests and Commit Messages'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/linked-references.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/linked-references.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
When an issue, pull request or comment is posted, the text description is parsed
|
When an issue, pull request or comment is posted, the text description is parsed
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Merge Message templates'
|
title: 'Merge Message templates'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/merge-message-templates.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/merge-message-templates.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## File names
|
## File names
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'OAuth2 provider'
|
title: 'OAuth2 provider'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/development/oauth2-provider.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/development/oauth2-provider.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent.
|
Forgejo supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Alpine Packages Repository'
|
title: 'Alpine Packages Repository'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/alpine.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/alpine.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Alpine](https://pkgs.alpinelinux.org/) packages for your user or organization.
|
Publish [Alpine](https://pkgs.alpinelinux.org/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Cargo Package Registry'
|
title: 'Cargo Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/cargo.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/cargo.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Cargo](https://doc.rust-lang.org/stable/cargo/) packages for your user or organization.
|
Publish [Cargo](https://doc.rust-lang.org/stable/cargo/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Chef Package Registry'
|
title: 'Chef Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/chef.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/chef.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Chef](https://chef.io/) cookbooks for your user or organization.
|
Publish [Chef](https://chef.io/) cookbooks for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Composer Package Registry'
|
title: 'Composer Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/composer.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/composer.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Composer](https://getcomposer.org/) packages for your user or organization.
|
Publish [Composer](https://getcomposer.org/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Conan Package Registry'
|
title: 'Conan Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/conan.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/conan.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Conan](https://conan.io/) packages for your user or organization.
|
Publish [Conan](https://conan.io/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Conda Package Registry'
|
title: 'Conda Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/conda.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/conda.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Conda](https://docs.conda.io/en/latest/) packages for your user or organization.
|
Publish [Conda](https://docs.conda.io/en/latest/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Container Registry'
|
title: 'Container Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/container.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/container.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Open Container Initiative](https://opencontainers.org/) compliant images for your user or organization.
|
Publish [Open Container Initiative](https://opencontainers.org/) compliant images for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'CRAN Package Registry'
|
title: 'CRAN Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/cran.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/cran.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [R](https://www.r-project.org/) packages to a [CRAN](https://cran.r-project.org/)-like registry for your user or organization.
|
Publish [R](https://www.r-project.org/) packages to a [CRAN](https://cran.r-project.org/)-like registry for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Debian Package Registry'
|
title: 'Debian Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/debian.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/debian.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Debian](https://www.debian.org/distrib/packages) packages for your user or organization.
|
Publish [Debian](https://www.debian.org/distrib/packages) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Generic Package Registry'
|
title: 'Generic Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/generic.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/generic.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish generic files, like release binaries or other output, for your user or organization.
|
Publish generic files, like release binaries or other output, for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Go Package Registry'
|
title: 'Go Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/go.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/go.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish Go packages for your user or organization.
|
Publish Go packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Helm Chart Registry'
|
title: 'Helm Chart Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/helm.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/helm.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Helm](https://helm.sh/) charts for your user or organization.
|
Publish [Helm](https://helm.sh/) charts for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Package Registry'
|
title: 'Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/storage.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/storage.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## Supported package managers
|
## Supported package managers
|
||||||
|
@ -145,7 +145,7 @@ The patterns are case-insensitive which matches the behaviour of the package reg
|
||||||
|
|
||||||
### How the cleanup rules work
|
### How the cleanup rules work
|
||||||
|
|
||||||
The cleanup rules are part of the [clean up job]../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.
|
The cleanup rules are part of the [clean up job](../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.
|
||||||
|
|
||||||
The cleanup rule:
|
The cleanup rule:
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Maven Package Registry'
|
title: 'Maven Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/maven.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/maven.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Maven](https://maven.apache.org) packages for your user or organization.
|
Publish [Maven](https://maven.apache.org) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'npm Package Registry'
|
title: 'npm Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/npm.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/npm.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [npm](https://www.npmjs.com/) packages for your user or organization.
|
Publish [npm](https://www.npmjs.com/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'NuGet Package Registry'
|
title: 'NuGet Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/nuget.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/nuget.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Pub Package Registry'
|
title: 'Pub Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/pub.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/pub.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization.
|
Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'PyPI Package Registry'
|
title: 'PyPI Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/pypi.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/pypi.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [PyPI](https://pypi.org/) packages for your user or organization.
|
Publish [PyPI](https://pypi.org/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'RPM Package Registry'
|
title: 'RPM Package Registry'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/rpm.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/rpm.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [RPM](https://rpm.org/) packages for your user or organization.
|
Publish [RPM](https://rpm.org/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'RubyGems Packages Repository'
|
title: 'RubyGems Packages Repository'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/rubygems.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/rubygems.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [RubyGems](https://guides.rubygems.org/) packages for your user or organization.
|
Publish [RubyGems](https://guides.rubygems.org/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Swift Packages Repository'
|
title: 'Swift Packages Repository'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/swift.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/swift.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## Swift Packages Repository
|
## Swift Packages Repository
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Vagrant Packages Repository'
|
title: 'Vagrant Packages Repository'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/vagrant.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/vagrant.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Publish [Vagrant](https://www.vagrantup.com/) packages for your user or organization.
|
Publish [Vagrant](https://www.vagrantup.com/) packages for your user or organization.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Profile customization'
|
title: 'Profile customization'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/profile-readme.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/profile-readme.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
By default the profile page of a user (or an organization) is the list of repositories they
|
By default the profile page of a user (or an organization) is the list of repositories they
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Branch and tag protection'
|
title: 'Branch and tag protection'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/protected-tags.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/protected-tags.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## Protected branches
|
## Protected branches
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Push Options'
|
title: 'Push Options'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/push.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/push.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
## Push To Create
|
## Push To Create
|
||||||
|
|
92
docs/user/repo-mirror.md
Normal file
92
docs/user/repo-mirror.md
Normal file
|
@ -0,0 +1,92 @@
|
||||||
|
---
|
||||||
|
title: 'Repository Mirrors'
|
||||||
|
license: 'Apache-2.0'
|
||||||
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/repo-mirror.en-us.md'
|
||||||
|
---
|
||||||
|
|
||||||
|
# Repository Mirror
|
||||||
|
|
||||||
|
Repository mirroring allows for the mirroring of repositories to and from external sources. You can use it to mirror branches, tags, and commits between repositories.
|
||||||
|
|
||||||
|
## Use cases
|
||||||
|
|
||||||
|
The following are some possible use cases for repository mirroring:
|
||||||
|
|
||||||
|
- You migrated to Forgejo but still need to keep your project in another source. In that case, you can simply set it up to mirror to Forgejo (pull) and all the essential history of commits, tags, and branches are available in your Forgejo instance.
|
||||||
|
- You have old projects in another source that you don’t use actively anymore, but don’t want to remove for archiving purposes. In that case, you can create a push mirror so that your active Forgejo repository can push its changes to the old location.
|
||||||
|
|
||||||
|
## Pulling from a remote repository
|
||||||
|
|
||||||
|
For an existing remote repository, you can set up pull mirroring as follows:
|
||||||
|
|
||||||
|
1. Select **New Migration** in the **Create...** menu on the top right.
|
||||||
|
2. Select the remote repository service.
|
||||||
|
3. Enter a repository URL.
|
||||||
|
4. If the repository needs authentication fill in your authentication information.
|
||||||
|
5. Check the box **This repository will be a mirror**.
|
||||||
|
6. Select **Migrate repository** to save the configuration.
|
||||||
|
|
||||||
|
The repository now gets mirrored periodically from the remote repository. You can force a sync by selecting **Synchronize Now** in the repository settings.
|
||||||
|
|
||||||
|
:exclamation::exclamation: **NOTE:** You can only set up pull mirroring for repos that don't exist yet on your instance. Once the repo is created, you can't convert it into a pull mirror anymore. :exclamation::exclamation:
|
||||||
|
|
||||||
|
## Pushing to a remote repository
|
||||||
|
|
||||||
|
For an existing repository, you can set up push mirroring as follows:
|
||||||
|
|
||||||
|
1. In your repository, go to **Settings** > **Repository**, and then the **Mirror Settings** section.
|
||||||
|
2. Enter a repository URL.
|
||||||
|
3. If the repository needs authentication expand the **Authorization** section and fill in your authentication information. Note that the requested **password** can also be your access token.
|
||||||
|
4. Select **Add Push Mirror** to save the configuration.
|
||||||
|
|
||||||
|
The repository now gets mirrored periodically to the remote repository. You can force a sync by selecting **Synchronize Now**. In case of an error a message displayed to help you resolve it.
|
||||||
|
|
||||||
|
:exclamation::exclamation: **NOTE:** This will force push to the remote repository. This will overwrite any changes in the remote repository! :exclamation::exclamation:
|
||||||
|
|
||||||
|
### Setting up a push mirror from Forgejo to GitHub
|
||||||
|
|
||||||
|
To set up a mirror from Forgejo to GitHub, you need to follow these steps:
|
||||||
|
|
||||||
|
1. Create a [GitHub personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with the _public_repo_ box checked. Also check the **workflow** checkbox in case your repo uses GitHub Actions for continuous integration.
|
||||||
|
2. Create a repository with that name on GitHub. Unlike Forgejo, GitHub does not support creating repositories by pushing to the remote. You can also use an existing remote repo if it has the same commit history as your Forgejo repo.
|
||||||
|
3. In the settings of your Forgejo repo, fill in the **Git Remote Repository URL**: `https://github.com/<your_github_group>/<your_github_project>.git`.
|
||||||
|
4. Fill in the **Authorization** fields with your GitHub username and the personal access token as **Password**.
|
||||||
|
5. (Optional, available on Forgejo 1.18+) Select `Sync when new commits are pushed` so that the mirror will be updated as well as soon as there are changes. You can also disable the periodic sync if you like.
|
||||||
|
6. Select **Add Push Mirror** to save the configuration.
|
||||||
|
|
||||||
|
The repository pushes shortly thereafter. To force a push, select the **Synchronize Now** button.
|
||||||
|
|
||||||
|
### Setting up a push mirror from Forgejo to GitLab
|
||||||
|
|
||||||
|
To set up a mirror from Forgejo to GitLab, you need to follow these steps:
|
||||||
|
|
||||||
|
1. Create a [GitLab personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) with _write_repository_ scope.
|
||||||
|
2. Fill in the **Git Remote Repository URL**: `https://<destination host>/<your_gitlab_group_or_name>/<your_gitlab_project>.git`.
|
||||||
|
3. Fill in the **Authorization** fields with `oauth2` as **Username** and your GitLab personal access token as **Password**.
|
||||||
|
4. Select **Add Push Mirror** to save the configuration.
|
||||||
|
|
||||||
|
The repository pushes shortly thereafter. To force a push, select the **Synchronize Now** button.
|
||||||
|
|
||||||
|
### Setting up a push mirror from Forgejo to Bitbucket
|
||||||
|
|
||||||
|
To set up a mirror from Forgejo to Bitbucket, you need to follow these steps:
|
||||||
|
|
||||||
|
1. Create a [Bitbucket app password](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/) with the _Repository Write_ box checked.
|
||||||
|
2. Fill in the **Git Remote Repository URL**: `https://bitbucket.org/<your_bitbucket_group_or_name>/<your_bitbucket_project>.git`.
|
||||||
|
3. Fill in the **Authorization** fields with your Bitbucket username and the app password as **Password**.
|
||||||
|
4. Select **Add Push Mirror** to save the configuration.
|
||||||
|
|
||||||
|
The repository pushes shortly thereafter. To force a push, select the **Synchronize Now** button.
|
||||||
|
|
||||||
|
### Mirror an existing ssh repository
|
||||||
|
|
||||||
|
Currently Forgejo supports no ssh push mirrors. You can work around this by adding a `post-receive` hook to your Forgejo repository that pushes manually.
|
||||||
|
|
||||||
|
1. Make sure the user running Forgejo has access to the git repo you are trying to mirror to from shell.
|
||||||
|
2. On the web interface at the repository settings > git hooks add a post-receive hook for the mirror. I.e.
|
||||||
|
|
||||||
|
```
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
git push --mirror --quiet git@github.com:username/repository.git &>/dev/null &
|
||||||
|
echo "GitHub mirror initiated .."
|
||||||
|
```
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Access Token scope'
|
title: 'Access Token scope'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/development/oauth2-provider.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/development/oauth2-provider.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo supports scoped access tokens, which allow users to restrict tokens to operate only on selected url routes. Scopes are grouped by high-level API routes, and further refined to the following:
|
Forgejo supports scoped access tokens, which allow users to restrict tokens to operate only on selected url routes. Scopes are grouped by high-level API routes, and further refined to the following:
|
||||||
|
|
|
@ -61,16 +61,12 @@ The structure of the version number is `<MAJOR>.<MINOR>.<PATCH>+gitea-<GITEA VER
|
||||||
- `<MAJOR>.<MINOR>.<PATCH>` is conformant to [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
|
- `<MAJOR>.<MINOR>.<PATCH>` is conformant to [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
|
||||||
- `gitea-<GITEA VERSION>` is the Gitea version this Forgejo release is compatible with
|
- `gitea-<GITEA VERSION>` is the Gitea version this Forgejo release is compatible with
|
||||||
|
|
||||||
### Long Term Support (LTS) versions
|
|
||||||
|
|
||||||
The structure is the same as stable versions, with the `LTS` string added to the metadata: `<MAJOR>.<MINOR>.<PATCH>+LTS-gitea-<GITEA VERSION>`.
|
|
||||||
|
|
||||||
### Experimental and pre-release versions
|
### Experimental and pre-release versions
|
||||||
|
|
||||||
The structure of the version number is `<MAJOR>.<MINOR>.<PATCH>-<PRE-RELEASE>+gitea-<GITEA VERSION>`, where:
|
The structure of the version number is `<MAJOR>.<MINOR>.<PATCH>-dev-<SHA>+gitea-<GITEA VERSION>`, where:
|
||||||
|
|
||||||
- `<MAJOR>.<MINOR>.<PATCH>` is conformant to [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
|
- `<MAJOR>.<MINOR>.<PATCH>` is conformant to [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
|
||||||
- `<PRE-RELEASE>` is the pre-release version, such as a release candidate (`RC`)
|
- `<SHA>` is the Git SHA from which the release was built
|
||||||
- `gitea-<GITEA VERSION>` is the Gitea version this Forgejo release is compatible with
|
- `gitea-<GITEA VERSION>` is the Gitea version this Forgejo release is compatible with
|
||||||
|
|
||||||
## Legacy forgejo numbering scheme
|
## Legacy forgejo numbering scheme
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: 'Webhooks'
|
title: 'Webhooks'
|
||||||
license: 'Apache-2.0'
|
license: 'Apache-2.0'
|
||||||
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/webhooks.en-us.md'
|
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/webhooks.en-us.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
Forgejo supports webhooks for repository events. This can be configured in the settings
|
Forgejo supports webhooks for repository events. This can be configured in the settings
|
||||||
|
|
2068
pnpm-lock.yaml
2068
pnpm-lock.yaml
File diff suppressed because it is too large
Load diff
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
: ${FORGEJO:=/tmp/forgejo}
|
: ${FORGEJO:=/tmp/forgejo-binary}
|
||||||
|
|
||||||
function dependencies() {
|
function dependencies() {
|
||||||
if ! which jq curl > /dev/null ; then
|
if ! which jq curl > /dev/null ; then
|
||||||
|
@ -15,20 +15,21 @@ function latest() {
|
||||||
local major="$1"
|
local major="$1"
|
||||||
|
|
||||||
if test "$major" = "next" ; then
|
if test "$major" = "next" ; then
|
||||||
curl -sS https://codeberg.org/api/v1/repos/forgejo/forgejo/releases | jq -r '.[] | .tag_name' | sort -r | head -1
|
select="" # this will pick whatever is the highest numbered release
|
||||||
else
|
else
|
||||||
curl -sS https://codeberg.org/api/v1/repos/forgejo/forgejo/releases | jq -r '.[] | .tag_name | select(startswith("'$major'"))' | sort -r | head -1
|
select="$major"
|
||||||
fi
|
fi
|
||||||
|
curl -sS https://codeberg.org/api/v1/repos/forgejo-experimental/forgejo/releases | jq -r '.[] | .tag_name | select(startswith("'$select'"))' | sort --reverse --version-sort | head -1
|
||||||
}
|
}
|
||||||
|
|
||||||
function download() {
|
function download() {
|
||||||
local major="$1"
|
local major="$1"
|
||||||
|
|
||||||
if test -f /tmp/forgejo ; then
|
if test -f $FORGEJO ; then
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
local version=$(latest $major)
|
local version=$(latest $major)
|
||||||
curl -sS "https://codeberg.org/forgejo/forgejo/releases/download/${version}/forgejo-${version#v}-linux-amd64" > ${FORGEJO}
|
curl -sS "https://codeberg.org/forgejo-experimental/forgejo/releases/download/${version}/forgejo-${version#v}-linux-amd64" > ${FORGEJO}
|
||||||
chmod +x ${FORGEJO}
|
chmod +x ${FORGEJO}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -155,7 +156,8 @@ function generate() {
|
||||||
function cleanup() {
|
function cleanup() {
|
||||||
sed \
|
sed \
|
||||||
-e 's/forgejo-dump-.*.zip/forgejo-dump-<timestamp>.zip/' \
|
-e 's/forgejo-dump-.*.zip/forgejo-dump-<timestamp>.zip/' \
|
||||||
-e '/^ *actions *$/d'
|
-e '/^ *actions *$/d' \
|
||||||
|
-e 's/ *$//'
|
||||||
}
|
}
|
||||||
|
|
||||||
function run() {
|
function run() {
|
||||||
|
|
Loading…
Reference in a new issue