coder/code-server
1
0
Fork 0
mirror of https://github.com/coder/code-server.git synced 2026-04-20 22:43:05 -05:00
Code Issues Packages Projects Releases 202 Wiki Activity

clean up npm docs and add Windows 10 instructions

Browse Source
This commit is contained in:
Ben Potter
2021-08-22 12:36:41 -05:00
parent 30dc47df9e
commit d4ca5a415a
2 changed files with 61 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/npm.md
View File

@@ -1,6 +1,6 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# npm Install Requirements
# yarn, npm
- [Node.js version](#nodejs-version)
- [Ubuntu, Debian](#ubuntu-debian)
@@ -35,6 +35,8 @@ sudo apt-get install -y \
npm config set python python3
```
Proceed to [installing](#installing)
## Fedora, CentOS, RHEL
```bash
@@ -44,6 +46,8 @@ sudo yum install -y python2
npm config set python python2
```
Proceed to [installing](#installing)
## Alpine
```bash
@@ -51,12 +55,16 @@ apk add alpine-sdk bash libstdc++ libc6-compat
npm config set python python3
```
Proceed to [installing](#installing)
## macOS
```bash
xcode-select --install
```
Proceed to [installing](#installing)
## FreeBSD
```sh
@@ -64,7 +72,49 @@ pkg install -y git python npm-node14 yarn-node14 pkgconf
pkg install -y libinotify
```
## Issues with Node.js after version upgrades
Proceed to [installing](#installing)
## Windows
Installing code-server requires all of the [prerequisites for VS Code development](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). When installing the C++ compiler tool chain, we recommend using "Option 2: Visual Studio 2019" for best results.
Next, install code-server with:
```bash
yarn global add code-server
# Or: npm install -g code-server
code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
A `postinstall.sh` script will attempt to run. Select your terminal (e.g git bash) as the default application for .sh files. If an additional dialog does not appear, run the install command again.
If the `code-server` command is not found, you'll need to [add a directory to your PATH](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/). To find the directory, use the following commands:
```shell
yarn global bin
# Or: npm config get prefix
```
For help and additional troubleshooting, see [#1397](https://github.com/cdr/code-server/issues/1397).
## Installing
After adding the dependencies for your OS, install code-server package globally:
```bash
yarn global add code-server
# Or: npm install -g code-server
code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
## Troubleshooting
If you need further assistance, post on our [GitHub Discussions
page](https://github.com/cdr/code-server/discussions).
### Issues with Node.js after version upgrades
Occasionally, you may run into issues with Node.js.
@@ -79,6 +129,3 @@ A step-by-step example of how you might do this is:
2. Navigate into the directory: `cd /usr/local/Cellar/code-server/<version>/libexec/lib/vscode/`
3. Recompile the native modules: `npm rebuild`
4. Restart code-server
If you need further assistance, post on our [GitHub Discussions
page](https://github.com/cdr/code-server/discussions).