Skip to content

Commit cbc9966

Browse files
committed
Update readme and getting-started guide
1 parent 3cf535e commit cbc9966

File tree

2 files changed

+29
-25
lines changed

2 files changed

+29
-25
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,6 @@ Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](d
4646
4747
How to [secure your setup](/doc/security/ssl.md).
4848
49-
### Telemetry
50-
51-
Use the `--disable-telemetry` flag to disable tracking ENTIRELY.
52-
53-
We use data collected to improve code-server.
54-
5549
## Development
5650
5751
### Known Issues
@@ -69,6 +63,12 @@ We use data collected to improve code-server.
6963
7064
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.
7165
66+
## Telemetry
67+
68+
Use the `--disable-telemetry` flag or set `DISABLE_TELEMETRY=true` to disable tracking ENTIRELY.
69+
70+
We use data collected to improve code-server.
71+
7272
## Contributing
7373
7474
Development guides are coming soon.

doc/self-hosted/index.md

+23-19
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,29 @@ It takes just a few minutes to get your own self-hosted server running. If you'v
3434
code-server can be ran with a number of arguments to customize your working directory, host, port, and SSL certificate.
3535

3636
```
37-
USAGE
38-
$ code-server [WORKDIR]
39-
40-
ARGUMENTS
41-
WORKDIR [default: (directory to binary)] Specify working dir
42-
43-
OPTIONS
44-
-d, --data-dir=data-dir
45-
-h, --host=host [default: 0.0.0.0]
46-
-o, --open Open in browser on startup
47-
-p, --port=port [default: 8443] Port to bind on
48-
-v, --version show CLI version
49-
--allow-http
50-
--cert=cert
51-
--cert-key=cert-key
52-
--help show CLI help
53-
--no-auth
54-
--password=password
37+
Usage: code-server [options]
38+
39+
Run VS Code on a remote server.
40+
41+
Options:
42+
-V, --version output the version number
43+
--cert <value>
44+
--cert-key <value>
45+
-e, --extensions-dir <dir> Set the root path for extensions.
46+
-d --user-data-dir <dir> Specifies the directory that user data is kept in, useful when running as root.
47+
--data-dir <value> DEPRECATED: Use '--user-data-dir' instead. Customize where user-data is stored.
48+
-h, --host <value> Customize the hostname. (default: "0.0.0.0")
49+
-o, --open Open in the browser on startup.
50+
-p, --port <number> Port to bind on. (default: 8443)
51+
-N, --no-auth Start without requiring authentication.
52+
-H, --allow-http Allow http connections.
53+
-P, --password <value> Specify a password for authentication.
54+
--disable-telemetry Disables ALL telemetry.
55+
-h, --help output usage information
5556
```
5657

5758
### Data Directory
58-
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
59+
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.
5960

6061
### Host
6162
By default, code-server will use `0.0.0.0` as its address. This can be changed by using `code-server -h` or `code-server --host=` followed by the address you want to use.
@@ -68,6 +69,9 @@ OPTIONS
6869
By default, code-server will use `8443` as its port. This can be changed by using `code-server -p` or `code-server --port=` followed by the port you want to use.
6970
> Example: `code-server -p 9000`
7071
72+
### Telemetry
73+
Disable all telemetry with `code-server --disable-telemetry`.
74+
7175
### Cert and Cert Key
7276
To encrypt the traffic between the browser and server use `code-server --cert=` followed by the path to your `.cer` file. Additionally, you can use certificate keys with `code-server --cert-key` followed by the path to your `.key` file.
7377
> Example (certificate and key): `code-server --cert /etc/letsencrypt/live/example.com/fullchain.cer --cert-key /etc/letsencrypt/live/example.com/fullchain.key`

0 commit comments

Comments
 (0)