a
/
code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
code-server/docs/npm.md

85 lines
2.4 KiB
Markdown
Raw Normal View History

Rename container and release-container to images and release-image
2020-06-03 16:07:42 +00: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 03:11:31 +00:00
# npm Install Requirements
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
- [Node.js version](#nodejs-version)
feat: update node version engine in package.json
2021-03-09 21:47:23 +00:00
- [Ubuntu, Debian](#ubuntu-debian)
- [Fedora, CentOS, RHEL](#fedora-centos-rhel)
- [Alpine](#alpine)
- [macOS](#macos)
- [FreeBSD](#freebsd)
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
- [Issues with Node.js after version upgrades](#issues-with-nodejs-after-version-upgrades)
Rename container and release-container to images and release-image
2020-06-03 16:07:42 +00:00
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
If you're installing code-server via `npm`, you'll need to install additional
dependencies required to build the native modules used by VS Code. This article
includes installing instructions based on your operating system.
Document npm module install dependencies
2020-05-13 03:11:31 +00:00
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
## Node.js version
docs(npm): update node requirements
2021-03-09 18:20:14 +00:00
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
We use the same major version of Node.js shipped with VSCode's Electron,
which is currently `14.x`. VS Code also [lists Node.js
requirements](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites).
docs(npm): update node requirements
2021-03-09 18:20:14 +00:00
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
Using other versions of Node.js [may lead to unexpected
behavior](https://github.com/cdr/code-server/issues/1633).
Require minimum node 12
2020-05-15 01:37:58 +00:00
Document npm module install dependencies
2020-05-13 03:11:31 +00: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-26 17:54:42 +00:00
python3
npm config set python python3
Document npm module install dependencies
2020-05-13 03:11:31 +00:00
```
Add install.sh into README.md
2020-05-20 16:13:03 +00:00
## Fedora, CentOS, RHEL
Document npm module install dependencies
2020-05-13 03:11:31 +00: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 15:41:13 +00: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-25 16:50:58 +00:00
sudo yum install -y python2
Document npm module install dependencies
2020-05-13 03:11:31 +00:00
npm config set python python2
```
doc/npm.md: Update docs for Alpine Linux (#2479)
2020-12-18 18:08:36 +00: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-25 16:50:58 +00:00
apk add alpine-sdk bash libstdc++ libc6-compat
doc/npm.md: Update docs for Alpine Linux (#2479)
2020-12-18 18:08:36 +00:00
npm config set python python3
```
Document npm module install dependencies
2020-05-13 03:11:31 +00:00
## macOS
doc/npm.md: Fix formatting
2020-12-04 07:34:18 +00:00
Document npm module install dependencies
2020-05-13 03:11:31 +00:00
```bash
xcode-select --install
```
doc/npm.md: Document npm module dependencies for FreeBSD
2020-12-14 23:25:08 +00:00
## FreeBSD
```sh
chore: update node to v14 (#3481)
2021-06-01 17:19:03 +00: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-25 16:50:58 +00:00
pkg install -y libinotify
doc/npm.md: Document npm module dependencies for FreeBSD
2020-12-14 23:25:08 +00:00
```
refactor(docs): clean up and restructure
2021-07-07 16:00:51 +00:00
## Issues with Node.js after version upgrades
Occasionally, you may run into issues with Node.js.
If you install code-server using `yarn` or `npm`, and you upgrade your Node.js
version, you may need to reinstall code-server to recompile native modules.
Sometimes, you can get around this by navigating into code-server's `lib/vscode`
directory and running `npm rebuild` to recompile the modules.
A step-by-step example of how you might do this is:
1. Install code-server: `brew install code-server`
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).