diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 50e90f1f21fa..20c987a2f14a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,6 +7,7 @@ assignees: '' --- + - `code-server` version: diff --git a/README.md b/README.md index 3407c2ebd6c6..51eede848ba4 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,9 @@ Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](d How to [secure your setup](/doc/security/ssl.md). +### Use VS Code Data +Use your existing VS Code configuration and extensions using the `--user-data-dir` and `--extensions-dir` flags. View the [quick start](doc/self-hosted/index.md) guide for more. + ## Development ### Known Issues diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index 8626599c0602..fdc0ba51f8bb 100644 --- a/doc/self-hosted/index.md +++ b/doc/self-hosted/index.md @@ -37,24 +37,33 @@ code-server can be ran with a number of arguments to customize your working dire USAGE $ code-server [WORKDIR] -ARGUMENTS - WORKDIR [default: (directory to binary)] Specify working dir - -OPTIONS - -d, --data-dir=data-dir - -h, --host=host [default: 0.0.0.0] - -o, --open Open in browser on startup - -p, --port=port [default: 8443] Port to bind on - -v, --version show CLI version - --allow-http - --cert=cert - --cert-key=cert-key - --help show CLI help - --no-auth - --password=password +Run VS Code on a remote server. + +Options: + -V, --version output the version number + --cert + --cert-key + -e, --extensions-dir Set the root path for extensions. + -d --user-data-dir Specifies the directory that user data is kept in, useful when running as root. + --data-dir DEPRECATED: Use '--user-data-dir' instead. Customize where user-data is stored. + -h, --host Customize the hostname. (default: "0.0.0.0") + -o, --open Open in the browser on startup. + -p, --port Port to bind on. (default: 8443) + -N, --no-auth Start without requiring authentication. + -H, --allow-http Allow http connections. + -P, --password Specify a password for authentication. + --bootstrap-fork Used for development. Never set. + --fork Used for development. Never set. + --extra-args Used for development. Never set. + --help output usage information ``` + ### Extension Directory + Specify a custom directory for extensions. Provides compatibility with local VS Code extensions by specifying `--extensions-dir ~/.vscode/extensions`. - ### Data Directory + ### User Data Directory + Specify where data is stored. Provides compatibility with local VS Code configuration by specifying `--user-data-dir ~/.config/User` (Linux) or `--user-data-dir ~/Library/Application\ Support/Code/` (MacOS). + + ### Data Directory (*deprecated*) Use `code-server -d (path/to/directory)` or `code-server --data-dir=(path/to/directory)`, excluding the parentheses to specify the root folder that VS Code will start in ### Host @@ -116,4 +125,4 @@ OPTIONS *Important:* For more details about Apache reverse proxy configuration checkout the [documentation](https://httpd.apache.org/docs/current/mod/mod_proxy.html) - especially the [Securing your Server](https://httpd.apache.org/docs/current/mod/mod_proxy.html#access) section ### Help - Use `code-server -h` or `code-server --help` to view the usage for the cli. This is also shown at the beginning of this section. + Use `code-server --help` to view the usage for the cli. This is also shown at the beginning of this section.