bughz
/
code-server
mirror of https://github.com/coder/code-server.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
code-server/docs/npm.md

152 lines
4.7 KiB
Markdown
Raw Normal View History

refactor: update prettier and doctoc (#5605) * docs: add toc to CODE OF CONDUCT * chore: add prettier ignore blocks to docs * chore: update styles for Dockerfile * refactor: separate prettier, doctoc This does a couple things: - update `.prettierignore` - split `prettier` and `doctoc` commands. you can still run with `yarn fmt` - delete `fmt.sh` and add `doctoc.sh` By doing so, we can run tasks in parallel in CI and we should also have less false positives than before with `yarn fmt` locally. * refactor: update prettier job, add doctoc This modifies the prettier job to use actionsx/prettier. It also adds a job for `doctoc`. * chore: upgrade to prettier 2.7.1 * chore: pin doctoc to 2.0.0 * fixup!: add .pc to prettierignore * feat: add --cache to prettier cmd
2022-10-14 06:16:55 +08:00
<!-- prettier-ignore-start -->
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 -->
format
2021-08-23 02:50:49 +08:00
# npm Install Requirements
Document npm module install dependencies
2020-05-13 11:11:31 +08:00
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
- [Node.js version](#nodejs-version)
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)
format
2021-08-23 02:50:49 +08:00
- [Windows](#windows)
- [Installing](#installing)
- [Troubleshooting](#troubleshooting)
- [Issues with Node.js after version upgrades](#issues-with-nodejs-after-version-upgrades)
docs: add note about npm logging
2021-08-25 06:25:04 +08:00
- [Debugging install issues with npm](#debugging-install-issues-with-npm)
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 -->
refactor: update prettier and doctoc (#5605) * docs: add toc to CODE OF CONDUCT * chore: add prettier ignore blocks to docs * chore: update styles for Dockerfile * refactor: separate prettier, doctoc This does a couple things: - update `.prettierignore` - split `prettier` and `doctoc` commands. you can still run with `yarn fmt` - delete `fmt.sh` and add `doctoc.sh` By doing so, we can run tasks in parallel in CI and we should also have less false positives than before with `yarn fmt` locally. * refactor: update prettier job, add doctoc This modifies the prettier job to use actionsx/prettier. It also adds a job for `doctoc`. * chore: upgrade to prettier 2.7.1 * chore: pin doctoc to 2.0.0 * fixup!: add .pc to prettierignore * feat: add --cache to prettier cmd
2022-10-14 06:16:55 +08:00
<!-- prettier-ignore-end -->
Rename container and release-container to images and release-image
2020-06-04 00:07:42 +08:00
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08: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 11:11:31 +08:00
docs: remove references to installing with yarn in favor of npm (#5518)
2022-08-31 01:00:11 +08:00
> **WARNING**: Do not use `yarn` to install code-server. Unlike `npm`, it does not respect
> lockfiles for distributed applications. It will instead use the latest version
> available at installation time - which might not be the one used for a given
> code-server release, and [might lead to unexpected behavior](https://github.com/coder/code-server/issues/4927).
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
## Node.js version
docs(npm): update node requirements
2021-03-10 02:20:14 +08:00
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! :tada: https://github.com/microsoft/vscode/commit/b0e8554cced292871a67748a18926cfd02f4e840 * 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 8d6b613e9d779ba18d0297710614516cde108bcf. * 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 31a354a34345309fadc475491b392d7601e51a32. * Revert "fixup!: delete github-auth patch" This reverts commit bdeb5212e8c7be6cadd109941b486a4bcdae69fa. * 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-05 05:58:49 +08:00
We use the same major version of Node.js shipped with Code's remote, which is
Update Code to 1.90.0 - Update Node to 20.11.1 - Update documentation
2024-06-06 16:59:33 +08:00
currently `20.x`. VS Code also [lists Node.js
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
requirements](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites).
docs(npm): update node requirements
2021-03-10 02:20:14 +08:00
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
Using other versions of Node.js [may lead to unexpected
docs: Update some more links (#4806) * Update links in package.json I will try checking the docs too * docs: Update links in triage.md * docs: Update links in npm.md * docs: Update links in whatever files that have `cdr` * Replace globally, thanks @bpmct! * fix: coderer instead of coder I should've used all three toggles in the Search/Replace tab in the GItHub.dev editor. * Code Formatting
2022-02-02 00:45:19 +08:00
behavior](https://github.com/coder/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
```
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
Proceed to [installing](#installing)
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
```
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
Proceed to [installing](#installing)
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
```
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
Proceed to [installing](#installing)
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
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
Proceed to [installing](#installing)
doc/npm.md: Document npm module dependencies for FreeBSD
2020-12-15 07:25:08 +08:00
## FreeBSD
```sh
Update Code to 1.90.0 - Update Node to 20.11.1 - Update documentation
2024-06-06 16:59:33 +08:00
pkg install -y git python npm-node20 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
```
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
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
Only require unsafe-perm if you are root Remove it from the docs, as the error message should be sufficient and it seems weird to recommend unsafe-perm by default.
2024-04-17 02:46:25 +08:00
npm install --global code-server
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
Correct default shell docs for npm on Windows (#6078)
2023-03-17 01:46:11 +08:00
A `postinstall.sh` script will attempt to run. Select your terminal (e.g., Git bash) as the default shell for npm run-scripts. If an additional dialog does not appear, run the install command again.
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
fix typo
2021-08-23 01:45:09 +08:00
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 command:
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
```shell
docs: remove references to installing with yarn in favor of npm (#5518)
2022-08-31 01:00:11 +08:00
npm config get prefix
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
```
docs: Update some more links (#4806) * Update links in package.json I will try checking the docs too * docs: Update links in triage.md * docs: Update links in npm.md * docs: Update links in whatever files that have `cdr` * Replace globally, thanks @bpmct! * fix: coderer instead of coder I should've used all three toggles in the Search/Replace tab in the GItHub.dev editor. * Code Formatting
2022-02-02 00:45:19 +08:00
For help and additional troubleshooting, see [#1397](https://github.com/coder/code-server/issues/1397).
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
## Installing
Update docs/npm.md Co-authored-by: Katie Horne <katie@coder.com>
2021-08-24 00:06:44 +08:00
After adding the dependencies for your OS, install the code-server package globally:
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
```bash
Only require unsafe-perm if you are root Remove it from the docs, as the error message should be sufficient and it seems weird to recommend unsafe-perm by default.
2024-04-17 02:46:25 +08:00
npm install --global code-server
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
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
docs: Update some more links (#4806) * Update links in package.json I will try checking the docs too * docs: Update links in triage.md * docs: Update links in npm.md * docs: Update links in whatever files that have `cdr` * Replace globally, thanks @bpmct! * fix: coderer instead of coder I should've used all three toggles in the Search/Replace tab in the GItHub.dev editor. * Code Formatting
2022-02-02 00:45:19 +08:00
page](https://github.com/coder/code-server/discussions).
clean up npm docs and add Windows 10 instructions
2021-08-23 01:36:41 +08:00
### Issues with Node.js after version upgrades
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
Occasionally, you may run into issues with Node.js.
docs: remove references to installing with yarn in favor of npm (#5518)
2022-08-31 01:00:11 +08:00
If you install code-server using `npm`, and you upgrade your Node.js
refactor(docs): clean up and restructure
2021-07-08 00:00:51 +08:00
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
docs: add note about npm logging
2021-08-25 06:25:04 +08:00
### Debugging install issues with npm
docs: remove references to installing with yarn in favor of npm (#5518)
2022-08-31 01:00:11 +08:00
To debug installation issues, install with `npm`:
docs: add note about npm logging
2021-08-25 06:25:04 +08:00
```shell
# Uninstall
Only require unsafe-perm if you are root Remove it from the docs, as the error message should be sufficient and it seems weird to recommend unsafe-perm by default.
2024-04-17 02:46:25 +08:00
npm uninstall --global code-server > /dev/null 2>&1
docs: add note about npm logging
2021-08-25 06:25:04 +08:00
# Install with logging
Only require unsafe-perm if you are root Remove it from the docs, as the error message should be sufficient and it seems weird to recommend unsafe-perm by default.
2024-04-17 02:46:25 +08:00
npm install --loglevel verbose --global code-server
docs: add note about npm logging
2021-08-25 06:25:04 +08:00
```