Skip to content

New flags readme #422

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.

Sign up for GitHub

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

New flags readme #422

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b810315
Update quick start guide usage, add new flags, update readme with new…
Apr 3, 2019
43a0afa
Rename header
Apr 3, 2019
3a3b7ba
Replace removed octothorpe
Apr 3, 2019
19356f3
Revise based on feedback
Apr 4, 2019
13962c2
Remove line break
Apr 4, 2019
7a2ec01
Add user data dir for macos, remove -h for host
Apr 15, 2019
40cc705
Fix another -h instance
Apr 16, 2019
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ assignees: ''
---

<!-- Please search existing issues to avoid creating duplicates. -->
<!-- Issues with ide.coder.com should be made here https://github.com/codercom/bugs/issues. -->
<!-- All extension-specific issues should be created with the `Extension Bug` template. -->

- `code-server` version: <!-- The version of code-server -->
Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

### 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.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe:

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 guide for more.


## Development

### Known Issues
Expand Down
41 changes: 25 additions & 16 deletions doc/self-hosted/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <value>
--cert-key <value>
-e, --extensions-dir <dir> Set the root path for extensions.
-d --user-data-dir <dir> Specifies the directory that user data is kept in, useful when running as root.
--data-dir <value> DEPRECATED: Use '--user-data-dir' instead. Customize where user-data is stored.
-h, --host <value> Customize the hostname. (default: "0.0.0.0")
-o, --open Open in the browser on startup.
-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.
--bootstrap-fork <name> Used for development. Never set.
--fork <name> Used for development. Never set.
--extra-args <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`
Copy link
Member

Choose a reason for hiding this comment

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

Feels a bit difficult to parse this. Maybe:

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 the root folder that VS Code will start in. This allows inheriting local VS Code configuration. Example `--user-data-dir ~/.config/User`
Copy link
Member

Choose a reason for hiding this comment

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

Maybe:

Specify where data is stored. Provides compatibility with local VS Code configuration by specifying `--user-data-dir ~/.config/User`.

Copy link

Choose a reason for hiding this comment

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

I realize this is correct for Linux, but for mac (at least on my installation), the local VS Code configuration is stored in --user-data-dir ~/Library/Application\ Support/Code/
It'd be nice to list both.


### 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
Expand Down