diff options
Diffstat (limited to 'docs/content/doc/usage/command-line.md')
| -rw-r--r-- | docs/content/doc/usage/command-line.md | 39 |
1 files changed, 28 insertions, 11 deletions
diff --git a/docs/content/doc/usage/command-line.md b/docs/content/doc/usage/command-line.md index e3e1f2356b..63f4a2a907 100644 --- a/docs/content/doc/usage/command-line.md +++ b/docs/content/doc/usage/command-line.md @@ -20,13 +20,17 @@ menu: `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`). + - `--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 + +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). @@ -36,10 +40,14 @@ Starts the server - `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. + - 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 + +Admin operations: + - Commands: - `create-user` - Options: @@ -51,18 +59,24 @@ Admin operations - Examples: - `gitea admin create-user --name myname --password asecurepassword --email me@example.com` - `change-password` - - Arguments: + - Options: - `--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. + +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). + - `--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. @@ -70,7 +84,10 @@ Generates a self-signed SSL certificate. Outputs to `cert.pem` and `key.pem` in - `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. + +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). |