Skip to content

Added Password updates to the self hosted index.md #625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion doc/self-hosted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,27 @@ Options:
-p, --port <number> Port to bind on. (default: 8443)
-N, --no-auth Start without requiring authentication.
-H, --allow-http Allow http connections.
-P, --password <value> Specify a password for authentication.
-P, --password <value> DEPRECATED in 1.903-vsc1.33.1: Use "PASSWORD" environment variable instead. Specify a password for authentication.
--disable-telemetry Disables ALL telemetry.
--help output usage information
```

### Password
If you're using the binary, the latest version of code-server allows you to set an environment variable PASSWORD

```
export PASSWORD="yourpassword"
./code-server --allow-http
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a newline after this codeblock if there's one above it.

If you're using docker, you can use the -e flag to pass environment variables to your container
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-e should be in backticks, and this line should end in a fullstop or colon.


```docker run -it -p 127.0.0.1:8443:8443 -e PASSWORD='yourpassword' -v "${PWD}:/home/coder/project" codercom/code-server --allow-http```

If you're using versions older than 1.903-vsc1.33.1, you must use the --password argument.

```./code-server --allow-http --password "yourpassword"```

```docker run -it -p 127.0.0.1:8443:8443 -v "${PWD}:/home/coder/project" codercom/code-server --allow-http --password "yourpassword"```

### Data Directory
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.
Expand Down