OCram85/code-server
Archived
1
0
Fork 0
Code Pull Requests 2 Activity
This repository has been archived on 2024-09-09. You can view files and clone it, but cannot push or open issues or pull requests.
7224b68b68
code-server/docs/npm.md
Joe Previte 7027ec7d60
chore: upgrade Code to 1.66 (#5135) 
* chore: upgrade Code to 1.66

* docs: update docs for Code upgrades

* fixup!: docs

* chore: update vscode submodule

* chore: update integration patch

* chore: update node-version patch

* chore: update github-auth patch

They completely changed how auth is handled for GitHub in
https://github.com/microsoft/vscode/pull/145424 so our patch may not
work. Will need to test and revisit.

* refactor: remove postinstall patch

It appears they renamed postinstall.js to postinstall.mjs and removed
the use of `rimraf` which means our patch is no longer needed! 🎉

b0e8554cce

* chore: refresh local-storage patch

* chore: refresh service-worker patch

* chore: bulk refresh patches

* fixup!: docs formatting

* refactor: remove unused last-opened patch

* fixup!: formatting docs

* fixup!: formatting docs

* refactor: remove rsync postinstall

* Revert "refactor: remove rsync postinstall"

This reverts commit 8d6b613e9d.

* refactor: update postinstall.js to .mjs

* feat(patches): add parent-origin bypass

* docs(patches): add notes for testing store-socket

* docs(patches): update testing info for node-version

* refactor(patches): delete github-auth.diff patch

* docs(patches): add notes for testing connection-type

* fixup!: delete github-auth patch

* fixup!: update connection type testing

* docs(patches): add notes to insecure-notification.diff

* docs(patches): add nots for update-check.diff

* fixup!: remove comma in integration patch

* fix(e2e): disable workspace trust

* refactor: add --no-default-rc for yarn install

* feat(patches): remove yarnrc in presinstall

* fixup!: silly mistake

* docs: add note about KEEP_MODULES=1

* docs(patches): add testing notes for node-version

* refactor(patches): remove node-version

It appears this is no longer needed due to the `remote/package.json` now which
targets node rather than electron.

* fixup!: add cd ../.. to code upgrade instructions

* fixup!: add note to yarn --production flag

* fixup!: make parent-origin easier to upstream

* Revert "refactor(patches): delete github-auth.diff patch"

This reverts commit 31a354a343.

* Revert "fixup!: delete github-auth patch"

This reverts commit bdeb5212e8.

* Merge webview origin patch into webview patch

* Remove unused post-install patch

* Prevent builtin extensions from updating

* Refresh sourcemaps patch

* Update Node to v16

This matches the version in ./lib/vscode/remote/.yarnrc.

I changed the engine to exactly 16 since if you use any different
version it will just not work since the modules will have been built for
16 (due to the .yarnrc).

* Replace fs.rmdir with fs.rm

Node is showing a deprecation warning about it.

* Update github-auth patch

The local credentials provider is no longer used when there is a remote
so this code moved into the backend web credential provider.

* Prevent fs.rm from erroring about non-existent files

We were using fs.rmdir which presumably did not have the same behavior
in v14 (in v16 fs.rmdir also errors).

* Install Python 3 in CentOS CI container

Co-authored-by: Asher <ash@coder.com>
2022-05-04 21:58:49 +00:00

4.4 KiB
Raw Blame History

npm Install Requirements

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.

Node.js version

We use the same major version of Node.js shipped with Code's remote, which is currently 16.x. VS Code also lists Node.js requirements.

Using other versions of Node.js may lead to unexpected behavior.

Ubuntu, Debian

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

Proceed to installing

Fedora, CentOS, RHEL

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

Proceed to installing

Alpine

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

Proceed to installing

macOS

xcode-select --install

Proceed to installing

FreeBSD

pkg install -y git python npm-node16 yarn-node16 pkgconf
pkg install -y libinotify

Proceed to installing

Windows

Installing code-server requires all of the prerequisites for VS Code development. When installing the C++ compiler tool chain, we recommend using "Option 2: Visual Studio 2019" for best results.

Next, install code-server with:

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. To find the directory, use the following command:

yarn global bin
# Or: npm config get prefix

For help and additional troubleshooting, see #1397.

Installing

After adding the dependencies for your OS, install the code-server package globally:

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.

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

Debugging install issues with npm

yarn suppresses logs when running yarn global add, so to debug installation issues, install with npm instead:

# Uninstall
npm uninstall -g --unsafe-perm code-server > /dev/null 2>&1

# Install with logging
npm install --loglevel verbose -g --unsafe-perm code-server