a
/
code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update code-server usage in documentation

This commit is contained in:
Dean Sheather 2019-07-07 17:03:47 +10:00
parent a65773338c
commit 14d917179c
No known key found for this signature in database
GPG Key ID: B574DF7CAFDCFAA3
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/self-hosted/index.md
View File

@ -38,21 +38,24 @@ Usage: code-server [options]
Run VS Code on a remote server. Run VS Code on a remote server.
Options: Options:
-V, --version output the version number -V, --version output the version number
--cert <value> --cert <value>
--cert-key <value> --cert-key <value>
-e, --extensions-dir <dir> Set the root path for extensions. -e, --extensions-dir <dir> Override the main default path for user extensions.
-d --user-data-dir <dir> Specifies the directory that user data is kept in, useful when running as root. --extra-extensions-dir [dir] Path to an extra user extension directory (repeatable). (default: [])
--data-dir <value> DEPRECATED: Use '--user-data-dir' instead. Customize where user-data is stored. --extra-builtin-extensions-dir [dir] Path to an extra built-in extension directory (repeatable). (default: [])
-h, --host <value> Customize the hostname. (default: "0.0.0.0") -d --user-data-dir <dir> Specifies the directory that user data is kept in, useful when running as root.
-o, --open Open in the browser on startup. -h, --host <value> Customize the hostname. (default: "0.0.0.0")
-p, --port <number> Port to bind on. (default: 8443) -o, --open Open in the browser on startup.
-N, --no-auth Start without requiring authentication. -p, --port <number> Port to bind on. (default: 8443)
-H, --allow-http Allow http connections. -N, --no-auth Start without requiring authentication.
-P, --password <value> Specify a password for authentication. -H, --allow-http Allow http connections.
--disable-telemetry Disables ALL telemetry. --disable-telemetry Disables ALL telemetry.
--help output usage information --socket <value> Listen on a UNIX socket. Host and port will be ignored when set.
``` --trust-proxy Trust the X-Forwarded-For header, useful when using a reverse proxy.
--install-extension <value> Install an extension by its ID.
-h, --help output usage information
```
### Data Directory ### Data Directory
Use `code-server -d (path/to/directory)` or `code-server --user-data-dir=(path/to/directory)`, excluding the parentheses to specify the root folder that VS Code will start in. Use `code-server -d (path/to/directory)` or `code-server --user-data-dir=(path/to/directory)`, excluding the parentheses to specify the root folder that VS Code will start in.