|
|
- ---
- date: "2017-01-01T16:00:00+02:00"
- title: "Usage: Command Line"
- slug: "command-line"
- weight: 10
- toc: true
- draft: false
- menu:
- sidebar:
- parent: "usage"
- name: "Command Line"
- weight: 10
- identifier: "command-line"
- ---
-
- ## Command Line
-
- ### Usage
-
- `gitea [global options] command [command options] [arguments...]`
-
- ### Global options
- - `--help`, `-h`: Show help text and exit. Optional. This can be used with any of the subcommands to see help text for it.
- - `--version`, `-v`: Show version and exit. Optional. (example: `Gitea version 1.1.0+218-g7b907ed built with: bindata, sqlite`).
-
- ### Commands
-
- #### web
- Starts the server
- - Options:
- - `--port number`, `-p number`: Port number. Optional. (default: 3000). Overrides configuration file.
- - `--config path`, `-c path`: Gitea configuration file path. Optional. (default: custom/conf/app.ini).
- - `--pid path`, `-P path`: Pidfile path. Optional.
- - Examples:
- - `gitea web`
- - `gitea web --port 80`
- - `gitea web --config /etc/gitea.ini --pid /var/run/gitea.pid`
- - Notes:
- - Gitea should not be run as root. To bind to a port below 1000, you can use setcap on Linux: `sudo setcap 'cap_net_bind_service=+ep' /path/to/gitea`. This will need to be redone every time you update Gitea.
-
- #### admin
- Admin operations
- - Commands:
- - `create-user`
- - Options:
- - `--name value`: Username. Required.
- - `--password value`: Password. Required.
- - `--email value`: Email. Required.
- - `--admin`: If provided, this makes the user an admin. Optional.
- - `--config path`: Gitea configuration file path. Optional. (default: custom/conf/app.ini).
- - Examples:
- - `gitea admin create-user --name myname --password asecurepassword --email me@example.com`
- - `change-password`
- - Arguments:
- - `--username value`, `-u value`: Username. Required.
- - `--password value`, `-p value`: New password. Required.
- - Examples:
- - `gitea admin change-password --username myname --password asecurepassword`
-
- #### cert
- Generates a self-signed SSL certificate. Outputs to `cert.pem` and `key.pem` in the current directory and will overwrite any existing files.
- - Options:
- - `--host value`: Comma seperated hostnames and ips which this certificate is valid for. Wildcards are supported. Required.
- - `--ecdsa-curve value`: ECDSA curve to use to generate a key. Optional. Valid options are P224, P256, P384, P521.
- - `--rsa-bits value`: Size of RSA key to generate. Optional. Ignored if --ecdsa-curve is set. (default: 2048).
- - `--start-date value`: Creation date. Optional. (format: `Jan 1 15:04:05 2011`).
- - `--duration value`: Duration which the certificate is valid for. Optional. (default: 8760h0m0s)
- - `--ca`: If provided, this cert generates it's own certificate authority. Optional.
- - Examples:
- - `gitea cert --host git.example.com,example.com,www.example.com --ca`
-
- #### dump
- Dumps all files and databases into a zip file. Outputs into a file like `gitea-dump-1482906742.zip` in the current directory.
- - Options:
- - `--config path`, `-c path`: Gitea configuration file path. Optional. (default: custom/conf/app.ini).
- - `--tempdir path`, `-t path`: Path to the temporary directory used. Optional. (default: /tmp).
- - `--verbose`, `-v`: If provided, shows additional details. Optional.
- - Examples:
- - `gitea dump`
- - `gitea dump --verbose`
|
