code-server/docs/npm.md

<!-- 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

- [Ubuntu, Debian](#ubuntu-debian)
- [Fedora, CentOS, RHEL](#fedora-centos-rhel)
- [Alpine](#alpine)
- [macOS](#macos)
- [FreeBSD](#freebsd)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

If you're installing the npm module you'll need certain dependencies to build the native modules used by VS Code.

- Node.js: version `= 14`. Other versions may work, but your mileage may vary.

_Note: We use the same major version of Node.js that is shipped in VSCode's Electron. VS Code also lists Node.js requirements. See [here](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites)._

Related:

- [#1633](https://github.com/cdr/code-server/issues/1633)

## Ubuntu, Debian

```bash
sudo apt-get install -y \
  build-essential \
  pkg-config \
  python3
npm config set python python3
```

## Fedora, CentOS, RHEL

```bash
sudo yum groupinstall -y 'Development Tools'
sudo yum config-manager --set-enabled PowerTools # unnecessary on CentOS 7
sudo yum install -y python2
npm config set python python2
```

## Alpine

```bash
apk add alpine-sdk bash libstdc++ libc6-compat
npm config set python python3
```

## macOS

```bash
xcode-select --install
```

## FreeBSD

```sh
pkg install -y git python npm-node14 yarn-node14 pkgconf
pkg install -y libinotify
```
Rename container and release-container to images and release-image 2020-06-04 00:07:42 +08:00			`<!-- START doctoc generated TOC please keep comment here to allow auto update -->`
			`<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->`
Document npm module install dependencies 2020-05-13 11:11:31 +08:00			`# npm Install Requirements`

feat: update node version engine in package.json 2021-03-10 05:47:23 +08:00			`- [Ubuntu, Debian](#ubuntu-debian)`
			`- [Fedora, CentOS, RHEL](#fedora-centos-rhel)`
			`- [Alpine](#alpine)`
			`- [macOS](#macos)`
			`- [FreeBSD](#freebsd)`
Rename container and release-container to images and release-image 2020-06-04 00:07:42 +08:00
			`<!-- END doctoc generated TOC please keep comment here to allow auto update -->`

docs(npm): update node requirements 2021-03-10 02:20:14 +08:00			`If you're installing the npm module you'll need certain dependencies to build the native modules used by VS Code.`
Document npm module install dependencies 2020-05-13 11:11:31 +08:00
chore: update node to v14 (#3481) 2021-06-02 01:19:03 +08:00			- Node.js: version `= 14`. Other versions may work, but your mileage may vary.
docs(npm): update node requirements 2021-03-10 02:20:14 +08:00
chore: update node to v14 (#3481) 2021-06-02 01:19:03 +08:00			`_Note: We use the same major version of Node.js that is shipped in VSCode's Electron. VS Code also lists Node.js requirements. See [here](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites)._`
docs(npm): update node requirements 2021-03-10 02:20:14 +08:00
			`Related:`

			`- [#1633](https://github.com/cdr/code-server/issues/1633)`
Require minimum node 12 2020-05-15 09:37:58 +08:00
Document npm module install dependencies 2020-05-13 11:11:31 +08:00			`## Ubuntu, Debian`

			```bash
			`sudo apt-get install -y \`
			`build-essential \`
			`pkg-config \`
doc: Update npm docs for debian sid There is no python package anymore, you have to explicitly pick which version of python to install and we need to inform npm of the executable name. 2020-08-27 01:54:42 +08:00			`python3`
			`npm config set python python3`
Document npm module install dependencies 2020-05-13 11:11:31 +08:00			```

Add install.sh into README.md 2020-05-21 00:13:03 +08:00			`## Fedora, CentOS, RHEL`
Document npm module install dependencies 2020-05-13 11:11:31 +08:00
			```bash
			`sudo yum groupinstall -y 'Development Tools'`
Stop bundling libraries in release - Instead we now use CentOS 7 for the static build to guarantee that we only depend on libc v2.17 - For macOS we now pull in a static node binary and bundle that instead. 2020-06-03 23:41:13 +08:00			`sudo yum config-manager --set-enabled PowerTools # unnecessary on CentOS 7`
fix(lib/vscode): remove native-keymap and keytar (#2961) native-keymap and keytar are only used in the electron process, so we don't need them. This allows us to drop our dependencies on libx11-dev, libxkbfile-dev, and libsecret-dev. 2021-03-26 00:50:58 +08:00			`sudo yum install -y python2`
Document npm module install dependencies 2020-05-13 11:11:31 +08:00			`npm config set python python2`
			```

doc/npm.md: Update docs for Alpine Linux (#2479) 2020-12-19 02:08:36 +08:00			`## Alpine`

			```bash
fix(lib/vscode): remove native-keymap and keytar (#2961) native-keymap and keytar are only used in the electron process, so we don't need them. This allows us to drop our dependencies on libx11-dev, libxkbfile-dev, and libsecret-dev. 2021-03-26 00:50:58 +08:00			`apk add alpine-sdk bash libstdc++ libc6-compat`
doc/npm.md: Update docs for Alpine Linux (#2479) 2020-12-19 02:08:36 +08:00			`npm config set python python3`
			```

Document npm module install dependencies 2020-05-13 11:11:31 +08:00			`## macOS`
doc/npm.md: Fix formatting 2020-12-04 15:34:18 +08:00
Document npm module install dependencies 2020-05-13 11:11:31 +08:00			```bash
			`xcode-select --install`
			```
doc/npm.md: Document npm module dependencies for FreeBSD 2020-12-15 07:25:08 +08:00
			`## FreeBSD`

			```sh
chore: update node to v14 (#3481) 2021-06-02 01:19:03 +08:00			`pkg install -y git python npm-node14 yarn-node14 pkgconf`
fix(lib/vscode): remove native-keymap and keytar (#2961) native-keymap and keytar are only used in the electron process, so we don't need them. This allows us to drop our dependencies on libx11-dev, libxkbfile-dev, and libsecret-dev. 2021-03-26 00:50:58 +08:00			`pkg install -y libinotify`
doc/npm.md: Document npm module dependencies for FreeBSD 2020-12-15 07:25:08 +08:00			```