code-server/docs/install.md

247 lines
9.2 KiB
Markdown
Raw Normal View History

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2020-05-20 16:13:03 +00:00
# Install
2021-02-12 21:05:01 +00:00
- [Upgrading](#upgrading)
- [install.sh](#installsh)
- [Flags](#flags)
- [Detection Reference](#detection-reference)
- [Debian, Ubuntu](#debian-ubuntu)
- [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
- [Arch Linux](#arch-linux)
2021-03-09 18:36:21 +00:00
- [Termux](#termux)
2021-05-12 21:59:17 +00:00
- [Raspberry Pi](#raspberry-pi)
2021-02-12 21:05:01 +00:00
- [yarn, npm](#yarn-npm)
- [macOS](#macos)
- [Standalone Releases](#standalone-releases)
- [Docker](#docker)
- [helm](#helm)
2021-03-08 23:59:14 +00:00
- [Cloud Providers](#cloud-providers)
- [Troubleshooting Node Issues](#troubleshooting-node-issues)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2020-05-20 16:13:03 +00:00
This document demonstrates how to install `code-server` on
various distros and operating systems.
## Upgrading
When upgrading you can just install the new version over the old one. code-server
maintains all user data in `~/.local/share/code-server` so that it is preserved in between
installations.
2020-05-21 21:10:29 +00:00
## install.sh
2020-06-13 14:56:50 +00:00
We have a [script](../install.sh) to install code-server for Linux, macOS and FreeBSD.
2020-05-22 03:53:02 +00:00
2020-05-22 02:16:16 +00:00
It tries to use the system package manager if possible.
2020-05-21 21:10:29 +00:00
First run to print out the install process:
```bash
2020-05-27 19:48:03 +00:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
2020-05-21 21:10:29 +00:00
```
Now to actually install:
```bash
curl -fsSL https://code-server.dev/install.sh | sh
```
2020-05-22 02:16:16 +00:00
The script will print out how to run and start using code-server.
2020-05-22 03:53:02 +00:00
If you believe an install script used with `curl | sh` is insecure, please give
[this wonderful blogpost](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) by
[sandstorm.io](https://sandstorm.io) a read.
2020-06-04 20:31:01 +00:00
If you'd still prefer manual installation despite the below [detection reference](#detection-reference) and `--dry-run`
2020-05-27 19:48:03 +00:00
then continue on for docs on manual installation. The [`install.sh`](../install.sh) script runs the _exact_ same
2020-05-22 03:53:02 +00:00
commands presented in the rest of this document.
### Flags
- `--dry-run` to echo the commands for the install process without running them.
2020-05-22 19:38:03 +00:00
- `--method` to choose the installation method.
2020-05-27 20:39:17 +00:00
- `--method=detect` to detect the package manager but fallback to `--method=standalone`.
- `--method=standalone` to install a standalone release archive into `~/.local`.
- `--prefix=/usr/local` to install a standalone release archive system wide.
2020-05-22 03:53:02 +00:00
- `--version=X.X.X` to install version `X.X.X` instead of latest.
- `--help` to see full usage docs.
2020-06-04 20:31:01 +00:00
### Detection Reference
2020-05-22 03:53:02 +00:00
2021-05-12 21:59:17 +00:00
- For Debian and Ubuntu it will install the latest deb package.
2020-05-22 02:16:16 +00:00
- For Fedora, CentOS, RHEL and openSUSE it will install the latest rpm package.
2020-05-21 21:10:29 +00:00
- For Arch Linux it will install the AUR package.
2020-05-27 20:39:17 +00:00
- For any unrecognized Linux operating system it will install the latest standalone release into `~/.local`.
2020-05-22 02:16:16 +00:00
- Add `~/.local/bin` to your `$PATH` to run code-server.
2020-05-21 21:10:29 +00:00
- For macOS it will install the Homebrew package.
2020-05-27 20:39:17 +00:00
- If Homebrew is not installed it will install the latest standalone release into `~/.local`.
2020-05-22 19:38:03 +00:00
- Add `~/.local/bin` to your `$PATH` to run code-server.
2020-05-21 21:10:29 +00:00
2020-06-13 14:56:50 +00:00
- For FreeBSD, it will install the [npm package](#yarn-npm) with `yarn` or `npm`.
2020-05-27 20:48:11 +00:00
- If ran on an architecture with no releases, it will install the [npm package](#yarn-npm) with `yarn` or `npm`.
2020-05-27 20:39:17 +00:00
- We only have releases for amd64 and arm64 presently.
2020-05-27 20:48:11 +00:00
- The [npm package](#yarn-npm) builds the native modules on postinstall.
2020-05-21 21:10:29 +00:00
2020-05-20 16:13:03 +00:00
## Debian, Ubuntu
NOTE: The standalone arm64 .deb does not support Ubuntu <16.04.
Please upgrade or [build with yarn](#yarn-npm).
2020-05-20 16:13:03 +00:00
```bash
curl -fOL https://github.com/cdr/code-server/releases/download/v$VERSION/code-server_$VERSION_amd64.deb
sudo dpkg -i code-server_$VERSION_amd64.deb
sudo systemctl enable --now code-server@$USER
2020-05-20 16:13:03 +00:00
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
## Fedora, CentOS, RHEL, SUSE
2020-05-20 16:13:03 +00:00
NOTE: The standalone arm64 .rpm does not support CentOS 7.
Please upgrade or [build with yarn](#yarn-npm).
2020-05-20 16:13:03 +00:00
```bash
curl -fOL https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-amd64.rpm
sudo rpm -i code-server-$VERSION-amd64.rpm
sudo systemctl enable --now code-server@$USER
2020-05-20 16:13:03 +00:00
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
## Arch Linux
```bash
# Installs code-server from the AUR using yay.
yay -S code-server
sudo systemctl enable --now code-server@$USER
2020-05-20 16:13:03 +00:00
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
```bash
# Installs code-server from the AUR with plain makepkg.
git clone https://aur.archlinux.org/code-server.git
cd code-server
makepkg -si
sudo systemctl enable --now code-server@$USER
2020-05-20 16:13:03 +00:00
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
2021-03-09 18:36:21 +00:00
## Termux
Please see "Installation" in the [Termux docs](./termux.md#installation)
2021-05-12 21:59:17 +00:00
## Raspberry Pi
If you're running a Raspberry Pi, we recommend install code-server with `yarn` or `npm`. See [yarn-npm](#yarn-npm).
2020-05-20 16:13:03 +00:00
## yarn, npm
2020-05-22 03:53:02 +00:00
We recommend installing with `yarn` or `npm` when:
2020-05-22 03:53:02 +00:00
1. You aren't on `amd64` or `arm64`.
2. If you're on Linux with glibc < v2.17 or glibcxx < v3.4.18 on amd64, or glibc < v2.23 or glibcxx < v3.4.21 on arm64.
3. You're running Alpine Linux, or are using a non-glibc libc. See [#1430](https://github.com/cdr/code-server/issues/1430#issuecomment-629883198)
2020-05-20 16:13:03 +00:00
**note:** Installing via `yarn` or `npm` builds native modules on install and so requires C dependencies.
2020-05-27 19:48:03 +00:00
See [./npm.md](./npm.md) for installing these dependencies.
2020-05-20 16:13:03 +00:00
You will need at least node v12 installed. See [#1633](https://github.com/cdr/code-server/issues/1633).
```bash
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
```
## macOS
```bash
brew install code-server
brew services start code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
2020-05-27 20:39:17 +00:00
## Standalone Releases
2020-05-20 16:13:03 +00:00
We publish self contained `.tar.gz` archives for every release on [github](https://github.com/cdr/code-server/releases).
2020-05-22 19:38:03 +00:00
They bundle the node binary and `node_modules`.
2020-05-20 16:13:03 +00:00
2020-05-27 21:55:57 +00:00
These are created from the [npm package](#yarn-npm) and the rest of the releases are created from these.
2020-06-04 09:54:15 +00:00
Only requirement is glibc >= 2.17 && glibcxx >= v3.4.18 on Linux and for macOS there is no minimum system requirement.
2020-05-27 21:55:57 +00:00
2020-05-20 16:13:03 +00:00
1. Download the latest release archive for your system from [github](https://github.com/cdr/code-server/releases).
2. Unpack the release.
3. You can run code-server by executing `./bin/code-server`.
2020-05-22 19:38:03 +00:00
You can add the code-server `bin` directory to your `$PATH` to easily execute `code-server`
without the full path every time.
2020-05-20 16:13:03 +00:00
2020-05-27 20:39:17 +00:00
Here is an example script for installing and using a standalone `code-server` release on Linux:
2020-05-20 16:13:03 +00:00
```bash
mkdir -p ~/.local/lib ~/.local/bin
curl -fL https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-linux-amd64.tar.gz \
| tar -C ~/.local/lib -xz
mv ~/.local/lib/code-server-$VERSION-linux-amd64 ~/.local/lib/code-server-$VERSION
ln -s ~/.local/lib/code-server-$VERSION/bin/code-server ~/.local/bin/code-server
PATH="~/.local/bin:$PATH"
2020-05-20 16:13:03 +00:00
code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
## Docker
2020-05-21 21:10:29 +00:00
```bash
# This will start a code-server container and expose it at http://127.0.0.1:8080.
# It will also mount your current directory into the container as `/home/coder/project`
# and forward your UID/GID so that all file system operations occur as your user outside
# the container.
#
# Your $HOME/.config is mounted at $HOME/.config within the container to ensure you can
# easily access/modify your code-server config in $HOME/.config/code-server/config.json
# outside the container.
mkdir -p ~/.config
docker run -it --name code-server -p 127.0.0.1:8080:8080 \
-v "$HOME/.config:/home/coder/.config" \
2020-05-21 21:10:29 +00:00
-v "$PWD:/home/coder/project" \
-u "$(id -u):$(id -g)" \
-e "DOCKER_USER=$USER" \
2020-05-21 21:10:29 +00:00
codercom/code-server:latest
```
Our official image supports `amd64` and `arm64`.
2020-05-22 19:38:03 +00:00
For `arm32` support there is a popular community maintained alternative:
[https://hub.docker.com/r/linuxserver/code-server](https://hub.docker.com/r/linuxserver/code-server)
2020-11-13 22:32:14 +00:00
## helm
See [the chart](../ci/helm-chart).
2021-02-16 05:43:10 +00:00
2021-03-08 23:59:14 +00:00
## Cloud Providers
2021-02-16 05:43:10 +00:00
2021-03-08 23:59:14 +00:00
We maintain one-click apps and install scripts for different cloud providers such as DigitalOcean, Railway, Heroku, Azure, etc. Check out the repository:
2021-02-16 05:43:10 +00:00
[https://github.com/cdr/deploy-code-server](https://github.com/cdr/deploy-code-server)
## Troubleshooting Node Issues
Occassionally, you may run into issues with node.
If you install code-server with `yarn`/`npm` and upgrade your node version, you may need to reinstall code-server to recompile native modules. Sometimes you can get around this by `cd`'ing into the `lib/vscode` directory under code-server and running `npm rebuild` to recompile those native modules.
An example of this might look like:
1. You installed code-server using `brew install code-server`
2. You `cd` into the directory `cd /usr/local/Cellar/code-server/<version>/libexec/lib/vscode/`
3. You recompile native modules by running `npm rebuild`
4. You restart code-server
If you get stuck or need help, post on our [GitHub Discussions page](https://github.com/cdr/code-server/discussions).