gitea(1)

Gitea(8)

System Manager's Manual

Gitea(8)

NAME

Gitea - A painless self-hosted Git service

SYNOPSIS

Gitea

[--config|-c]=[value]
[--custom-path|-C]=[value]
[--help|-h]
[--version|-v]
[--work-path|-w]=[value]

DESCRIPTION

By default, Gitea will start serving using the web-server with no argument, which can alternatively be run by running the subcommand "web".

Usage:

Gitea [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

GLOBAL OPTIONS

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--version, -v: print the version

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

COMMANDS

web

Start Gitea web server

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--install-port="": Temporary port number to run the install page on to prevent conflict (default: 3000)

--pid, -P="": Custom pid file path (default: /run/gitea.pid)

--port, -p="": Temporary port number to prevent conflict (default: 3000)

--quiet, -q: Only display Fatal logging errors until logging is set-up

--verbose: Set initial logging to TRACE level until logging is properly set-up

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

serv

This command should only be called by SSH shell

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--debug:

--enable-pprof:

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

hook

Delegate commands to corresponding Git hooks

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

pre-receive

Delegate pre-receive Git hook

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--debug:

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

update

Delegate update Git hook

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--debug:

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

post-receive

Delegate post-receive Git hook

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--debug:

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

proc-receive

Delegate proc-receive Git hook

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--debug:

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

dump

Dump Gitea files and database

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--database, -d="": Specify the database SQL syntax: sqlite3, mysql, mssql, postgres

--file, -f="": Name of the dump file which will be created. Supply '-' for stdout. See type for available types. (default: gitea-dump-1712324225.zip)

--help, -h: show help

--quiet, -q: Only display warnings and errors

--skip-attachment-data: Skip attachment data

--skip-custom-dir: Skip custom directory

--skip-index: Skip bleve index data

--skip-lfs-data: Skip LFS data

--skip-log, -L: Skip the log dumping

--skip-package-data: Skip package data

--skip-repository, -R: Skip the repository dumping

--tempdir, -t="": Temporary dir path (default: /usr/src/tmp)

--type="": Dump output format: zip, tar, tar.sz, tar.gz, tar.xz, tar.bz2, tar.br, tar.lz4, tar.zst (default: zip)

--verbose, -V: Show process details

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

admin

Command line interface to perform common administrative operations

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

user

Modify users

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

create

Create a new user in database

--access-token: Generate access token for the user

--admin: User is an admin

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--email="": User email address

--help, -h: show help

--must-change-password: Set this option to false to prevent forcing the user to change their password after initial login, (Default: true)

--name="": Username. DEPRECATED: use username instead

--password="": User password

--random-password: Generate a random password for the user

--random-password-length="": Length of the random password to be generated (default: 0)

--restricted: Make a restricted user account

--username="": Username

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

list

List users

--admin: List only admin users

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

change-password

Change a user's password

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--password, -p="": New password to set for user

--username, -u="": The user to change password for

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

delete

Delete specific user by id, name or email

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--email, -e="": Email of the user to delete

--help, -h: show help

--id="": ID of user of the user to delete (default: 0)

--purge: Purge user, all their repositories, organizations and comments

--username, -u="": Username of the user to delete

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

generate-access-token

Generate an access token for a specific user

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--raw: Display only the token value

--scopes="": Comma separated list of scopes to apply to access token

--token-name, -t="": Token name (default: gitea-admin)

--username, -u="": Username

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

must-change-password

Set the must change password flag for the provided users or all users

--all, -A: All users must change password, except those explicitly excluded with --exclude

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--exclude, -e="": Do not change the must-change-password flag for these users

--help, -h: show help

--unset: Instead of setting the must-change-password flag, unset it

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

repo-sync-releases

Synchronize repository releases with tags

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

regenerate

Regenerate specific files

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

hooks

Regenerate git-hooks

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

keys

Regenerate authorized_keys file

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

auth

Modify external auth providers

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

add-oauth

Add new Oauth authentication source

--admin-group="": Group Claim value for administrator users

--auto-discover-url="": OpenID Connect Auto Discovery URL (only required when using OpenID Connect as provider)

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-auth-url="": Use a custom Authorization URL (option for GitLab/GitHub)

--custom-email-url="": Use a custom Email URL (option for GitHub)

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--custom-profile-url="": Use a custom Profile URL (option for GitLab/GitHub)

--custom-tenant-id="": Use custom Tenant ID for OAuth endpoints

--custom-token-url="": Use a custom Token URL (option for GitLab/GitHub)

--group-claim-name="": Claim name providing group names for this source

--group-team-map="": JSON mapping between groups and org teams

--group-team-map-removal: Activate automatic team membership removal depending on groups

--help, -h: show help

--icon-url="": Custom icon URL for OAuth2 login source

--key="": Client ID (Key)

--name="": Application Name

--provider="": OAuth2 Provider

--required-claim-name="": Claim name that has to be set to allow users to login with this source

--required-claim-value="": Claim value that has to be set to allow users to login with this source

--restricted-group="": Group Claim value for restricted users

--scopes="": Scopes to request when to authenticate against this OAuth2 source

--secret="": Client Secret

--skip-local-2fa: Set to true to skip local 2fa for users authenticated by this source

--use-custom-urls="": Use custom URLs for GitLab/GitHub OAuth endpoints (default: false)

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

help, h

Shows a list of commands or help for one command

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')

--custom-path, -C="": Set custom path (defaults to '{WorkPath}/custom')

--help, -h: show help

--work-path, -w="": Set Gitea's working path (defaults to the Gitea's binary directory)

update-oauth

Update existing Oauth authentication source