From b8103159f1fc0ff927f04cf83f80f8dd8ceb2175 Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Wed, 3 Apr 2019 17:35:13 -0500 Subject: [PATCH 1/7] Update quick start guide usage, add new flags, update readme with new configuration options, update bug template to direct ide.coder.com issues to the correct place. --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + README.md | 5 +++- doc/self-hosted/index.md | 41 +++++++++++++++++----------- 3 files changed, 30 insertions(+), 17 deletions(-) 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..cea7e98e9dd9 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). +### Configuration +- Use your local VSCode configuration and locally installed extensions with the `--user-data-dir` and `--extensions-dir` flags. View the [quick start](doc/self-hosted/index.md) guide for more. + ## Development ### Known Issues @@ -63,7 +66,7 @@ How to [secure your setup](/doc/security/ssl.md). - Electron and Chrome OS applications to bridge the gap between local<->remote. - Run VS Code unit tests against our builds to ensure features work as expected. -### Extensions +## Extensions At the moment we can't use the official VSCode Marketplace. We've created a custom extension marketplace focused around open-sourced extensions. However, if you have access to the `.vsix` file, you can manually install the extension. diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index 8626599c0602..61816d81b13c 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. + -h, --help output usage information ``` + ### Extension Directory + Point code-server at a local directory with installed extensions. This allows inheriting local VSCode extensions by specifying `--extensions-dir ~/.vscode/extensions` - ### Data Directory + ### User Data Directory + Specify the root folder that VS Code will start in. This allows inheriting local VS Code configuration. Example `--user-data-dir ~/.config/User` + + ### 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 From 43a0afa31681d237676225fd9c366d4110a17e22 Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Wed, 3 Apr 2019 17:35:30 -0500 Subject: [PATCH 2/7] Rename header --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cea7e98e9dd9..f3b36271f7a6 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](d How to [secure your setup](/doc/security/ssl.md). -### Configuration +### Customize User Data - Use your local VSCode configuration and locally installed extensions with the `--user-data-dir` and `--extensions-dir` flags. View the [quick start](doc/self-hosted/index.md) guide for more. ## Development From 3a3b7ba69a193812fbf85e33555136e5f9e0a5c3 Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Wed, 3 Apr 2019 17:41:55 -0500 Subject: [PATCH 3/7] Replace removed octothorpe --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3b36271f7a6..42cc253dbe41 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ How to [secure your setup](/doc/security/ssl.md). - Electron and Chrome OS applications to bridge the gap between local<->remote. - Run VS Code unit tests against our builds to ensure features work as expected. -## Extensions +### Extensions At the moment we can't use the official VSCode Marketplace. We've created a custom extension marketplace focused around open-sourced extensions. However, if you have access to the `.vsix` file, you can manually install the extension. From 19356f347859e600308f18b361a37fe4f4be8241 Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Thu, 4 Apr 2019 12:22:47 -0500 Subject: [PATCH 4/7] Revise based on feedback --- README.md | 4 ++-- doc/self-hosted/index.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 42cc253dbe41..51eede848ba4 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,8 @@ Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](d How to [secure your setup](/doc/security/ssl.md). -### Customize User Data -- Use your local VSCode configuration and locally installed extensions with the `--user-data-dir` and `--extensions-dir` flags. View the [quick start](doc/self-hosted/index.md) guide for more. +### 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 diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index 61816d81b13c..d1156b89586b 100644 --- a/doc/self-hosted/index.md +++ b/doc/self-hosted/index.md @@ -58,10 +58,11 @@ Options: -h, --help output usage information ``` ### Extension Directory - Point code-server at a local directory with installed extensions. This allows inheriting local VSCode extensions by specifying `--extensions-dir ~/.vscode/extensions` + Specify a custom directory for extensions. Provides compatibility with local VS Code extensions by specifying `--extensions-dir ~/.vscode/extensions`. ### User Data Directory - Specify the root folder that VS Code will start in. This allows inheriting local VS Code configuration. Example `--user-data-dir ~/.config/User` + Specify where data is stored. Provides compatibility with local VS Code configuration by specifying `--user-data-dir ~/.config/User`. + ### 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 From 13962c29123eda001a2ddfbc50b05c62e636c09d Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Thu, 4 Apr 2019 12:23:56 -0500 Subject: [PATCH 5/7] Remove line break --- doc/self-hosted/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index d1156b89586b..52835a66e821 100644 --- a/doc/self-hosted/index.md +++ b/doc/self-hosted/index.md @@ -63,7 +63,6 @@ Options: ### User Data Directory Specify where data is stored. Provides compatibility with local VS Code configuration by specifying `--user-data-dir ~/.config/User`. - ### 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 From 7a2ec01e2731ded67d076288657c560c3a4eba98 Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Mon, 15 Apr 2019 16:38:45 -0500 Subject: [PATCH 6/7] Add user data dir for macos, remove -h for host --- doc/self-hosted/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index 52835a66e821..4d52e86b6d29 100644 --- a/doc/self-hosted/index.md +++ b/doc/self-hosted/index.md @@ -55,13 +55,13 @@ Options: --bootstrap-fork Used for development. Never set. --fork Used for development. Never set. --extra-args Used for development. Never set. - -h, --help output usage information + --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`. ### User Data Directory - Specify where data is stored. Provides compatibility with local VS Code configuration by specifying `--user-data-dir ~/.config/User`. + 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 From 40cc7054ab3a352c7f7f254ca38f8f244b8019e1 Mon Sep 17 00:00:00 2001 From: John McCambridge Date: Tue, 16 Apr 2019 09:54:36 -0500 Subject: [PATCH 7/7] Fix another -h instance --- doc/self-hosted/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index 4d52e86b6d29..fdc0ba51f8bb 100644 --- a/doc/self-hosted/index.md +++ b/doc/self-hosted/index.md @@ -125,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.