@@ -72,7 +72,7 @@ During the code-server installation process, the following packages will be inst
- For any unrecognized Linux operating system, code-server installs the latest standalone release into `~/.local`. Make sure that you add `~/.local/bin` to your `$PATH` to run code-server.
- For macOS code-server installs Homebrew to `~/.local`. Make sure that you add `~/.local/bin` to your `$PATH` to run code-server.
- For FreeBSD, code-server installs the [npm package](#yarn-npm) with `yarn` or `npm`
- If you run code-server on an architecture with no releases, it installs the [npm package](#yarn-npm) with `yarn` or `npm`. The [npm package](#yarn-npm) builds the native modules on postinstall. Please note that we currently have releases only for amd64 and arm64.
- If you run code-server on an architecture with no releases, it installs the [npm package](#yarn-npm) with `yarn` or `npm`. The [npm package](#yarn-npm) builds the native modules on postinstall. Please note that we currently have releases only for **amd64** and **arm64**.
# Your password is in ~/.config/code-server/config.yaml
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
### yarn, npm
...
...
@@ -136,8 +132,9 @@ You can install code-server using Yarn or npm. We recommend doing so if:
Notes:
- Installing code-server using Yarn or npm builds native modules on install, which requires [C dependencies](./npm.md) for installing these dependencies
- Installing code-server using Yarn or npm builds native modules on install, which requires [C dependencies](./npm.md) for install
- You must have Node.js version 12.x (or greater) installed
- If you're running macOS, install [Xcode](https://developer.apple.com/xcode/downloads/) and run `xcode-select --install` befor proceeding with the installation.
To install code-server using Yarn/npm:
...
...
@@ -145,15 +142,14 @@ To install code-server using Yarn/npm:
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
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
## Standalone Releases
For every release, we publish [self-contained .tar.gz archives](https://github.com/cdr/code-server/releases) that bundle the Node binary and modules.
The base for these were created from the [npm package](#yarn-npm) with all subsequent releases created from the base.
The base for these were created from the [npm package](#yarn-npm); we've created all subsequent releases using this base.
### Requirements
...
...
@@ -169,7 +165,7 @@ There are no minimum system requirements for macOS.
To use code-server, point your browser to **http://127.0.0.1:8080**. You can find your password in **~/.config/code-server/config.yaml**.
To run code-server without providing the full path, add the code-server `bin` directory to your `$PATH`.
If you'd like to run code-server without providing the full path, add the code-server `bin` directory to your `$PATH`.
# Your password is in ~/.config/code-server/config.yaml
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
### Docker
...
...
@@ -215,4 +210,4 @@ docker run -it -p 127.0.0.1:8080:8080 \
## Alternatives
Our official code-server image supports `amd64` and `arm64` architectures, but if you're using `arm32`, there is a [community-maintained alternative](https://hub.docker.com/r/linuxserver/code-server)
\ No newline at end of file
Our official code-server image supports `amd64` and `arm64` architectures, but if you're using `arm32`, there is a [community-maintained alternative](https://hub.docker.com/r/linuxserver/code-server)
<!-- 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.
This article shows you how to install the npm package required when [installing code-server](./install.md#yarn-npm) onto a machine with architecture for which we don't offer a designated release. The npm package builds the native modules used by VS Code.
You also need at least node v12 installed. See [#1633](https://github.com/cdr/code-server/issues/1633).
Before proceeding, please make sure that you have Node.js version 12.x (or later) installed.
## Ubuntu, Debian
## Debian, Ubuntu
To install the npm package on a machine running Debian or Ubuntu:
```bash
sudo apt-get install-y\
...
...
@@ -26,7 +27,9 @@ sudo apt-get install -y \
npm config set python python3
```
## Fedora, CentOS, RHEL
## CentOS, Fedora, RHEL
To install the npm package on a machine running CentOS, Fedora, or RHEL:
