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

Gitea program contains "web" and other subcommands. If no subcommand is given, it starts the web server by default. Use "web" subcommand for more web server arguments, use other subcommands for other purposes.

Usage:

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

GLOBAL OPTIONS

--config, -c="": Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini') (default: /etc/gitea/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

--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

help, h

Shows a list of commands or help for one command

dump

Dump Gitea files and database

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

--file, -f="": Name of the dump file which will be created, default to "gitea-dump-{time}.zip". Supply '-' for stdout. See type for available types.

--help, -h: show help

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

--skip-attachment-data: Skip attachment data

--skip-custom-dir: Skip custom directory

--skip-db: Skip database

--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, default to "zip", supported types: zip, tar, tar.sz, tar.gz, tar.xz, tar.bz2, tar.br, tar.lz4, tar.zst

--verbose, -V: Show process details

help, h

Shows a list of commands or help for one command

admin

Perform common administrative operations

--help, -h: show help

user

Modify users

--help, -h: show help

create

Create a new user in database

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

--access-token-name="": Name of the generated access token (default: gitea-admin)

--access-token-scopes="": Scopes of the generated access token, comma separated. Examples: "all", "public-only,read:issue", "write:repository,write:user" (default: all)

--admin: User is an admin

--email="": User email address

--fullname="": The full, human-readable name of the user

--help, -h: show help

--must-change-password: User must change password after initial login, defaults to true for all users except the first one (can be disabled by --must-change-password=false)

--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: 12)

--restricted: Make a restricted user account

--user-type="": Set user's type: individual or bot (default: individual)

--username="": Username

help, h

Shows a list of commands or help for one command

list

List users

--admin: List only admin users

--help, -h: show help

help, h

Shows a list of commands or help for one command

change-password

Change a user's password

--help, -h: show help

--must-change-password: User must change password (can be disabled by --must-change-password=false)

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

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

help, h

Shows a list of commands or help for one command

delete

Delete specific user by id, name or email

--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

help, h

Shows a list of commands or help for one command

generate-access-token

Generate an access token for a specific user

--help, -h: show help

--raw: Display only the token value

--scopes="": Comma separated list of scopes to apply to access token, examples: "all", "public-only,read:issue", "write:repository,write:user" (default: all)

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

--username, -u="": Username

help, h

Shows a list of commands or help for one command

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

--exclude, -e="": Do not change the must-change-password flag for these users (default: [])

--help, -h: show help

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

help, h

Shows a list of commands or help for one command

help, h

Shows a list of commands or help for one command

repo-sync-releases

Synchronize repository releases with tags

--help, -h: show help

help, h

Shows a list of commands or help for one command

regenerate

Regenerate specific files

--help, -h: show help

hooks

Regenerate git-hooks

--help, -h: show help

help, h

Shows a list of commands or help for one command

keys

Regenerate authorized_keys file

--help, -h: show help

help, h

Shows a list of commands or help for one command

help, h

Shows a list of commands or help for one command

auth

Modify external auth providers

--help, -h: show help

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)

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

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

--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)

--full-name-claim-name="": Claim name that provides user's full name

--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 (default: [])

--secret="": Client Secret

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

--ssh-public-key-claim-name="": Claim name that provides SSH public keys

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

help, h

Shows a list of commands or help for one command

update-oauth

Update existing Oauth authentication source