Merge pull request #1701 from cdr/auto-install

Add auto install script

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Report a bug and help us improve
-title: ''
+title: ""
-labels: ''
+labels: ""
-assignees: ''
+assignees: ""
-
 ---
 
 <!--

.github/ISSUE_TEMPLATE/extension-request.md

@@ -1,10 +1,9 @@
 ---
 name: Extension request
 about: Request an extension missing from the code-server marketplace
-title: ''
+title: ""
 labels: extension-request
 assignees: cmoog
-
 ---
 
 <!--

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea
-title: ''
+title: ""
 labels: feature
-assignees: ''
+assignees: ""
-
 ---
 
 <!--

.github/workflows/ci.yaml

@@ -54,10 +54,10 @@ jobs:
         with:
           name: npm-package
           path: ./release-npm-package
-      - name: Run ./ci/steps/release-static.sh
+      - name: Run ./ci/steps/release-packages.sh
         uses: ./ci/container
         with:
-          args: ./ci/steps/release-static.sh
+          args: ./ci/steps/release-packages.sh
       - name: Upload release artifacts
         uses: actions/upload-artifact@v2
         with:
@@ -74,10 +74,10 @@ jobs:
         with:
           name: npm-package
           path: ./release-npm-package
-      - name: Run ./ci/steps/release-static.sh
+      - name: Run ./ci/steps/release-packages.sh
         uses: ./ci/container/arm64
         with:
-          args: ./ci/steps/release-static.sh
+          args: ./ci/steps/release-packages.sh
       - name: Upload release artifacts
         uses: actions/upload-artifact@v2
         with:
@@ -96,7 +96,7 @@ jobs:
           path: ./release-npm-package
       - run: brew unlink node@12
       - run: brew install node
-      - run: ./ci/steps/release-static.sh
+      - run: ./ci/steps/release-packages.sh
         env:
           # Otherwise we get rate limited when fetching the ripgrep binary.
           # For whatever reason only MacOS needs it.

.gitignore

@@ -4,7 +4,7 @@ dist*
 out*
 release/
 release-npm-package/
-release-static/
+release-standalone/
 release-packages/
 release-gcp/
 release-images/

README.md

@@ -2,114 +2,45 @@
 
 Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
 
-- **Code everywhere:** Code on your Chromebook, tablet, and laptop with a
+![Screenshot](./doc/assets/screenshot.png)
-  consistent dev environment. Develop on a Linux machine and pick up from any
-  device with a web browser.
-- **Server-powered:** Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
-  Preserve battery life when you're on the go since all intensive tasks runs on your server.
-  Make use of a spare computer you have lying around and turn it into a full development environment.
 
-![Example gif](./doc/assets/code-server.gif)
+## Highlights
+
+- **Code everywhere**
+  - Code on your Chromebook, tablet, and laptop with a consistent development environment.
+  - Develop on a Linux machine and pick up from any device with a web browser.
+- **Server-powered**
+  - Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
+  - Preserve battery life when you're on the go as all intensive tasks runs on your server.
+  - Make use of a spare computer you have lying around and turn it into a full development environment.
 
 ## Getting Started
 
 For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
 
-### Debian, Ubuntu
+We have a [script](./install.sh) to install code-server for Linux and macOS.
+
+It tries to use the system package manager if possible.
+
+First run to print out the install process:
 
 ```bash
-curl -sSOL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server_3.3.1_amd64.deb
+curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
-sudo dpkg -i code-server_3.3.1_amd64.deb
-systemctl --user enable --now code-server
-# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
 ```
 
-### Fedora, Red Hat, SUSE
+Now to actually install:
 
 ```bash
-curl -sSOL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-amd64.rpm
+curl -fsSL https://code-server.dev/install.sh | sh
-sudo yum install -y code-server-3.3.1-amd64.rpm
-systemctl --user enable --now code-server
-# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
 ```
 
-### Arch Linux
+The install script will print out how to run and start using code-server.
 
-```bash
+If you believe an install script used with `curl | sh` is insecure, please give
-# Installs code-server from the AUR using yay.
+[this wonderful blogpost](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) by
-yay -S code-server
+[sandstorm.io](https://sandstorm.io) a read.
-systemctl --user enable --now code-server
-# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
-```
 
-```bash
+Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
-# Installs code-server from the AUR with plain makepkg.
-git clone https://aur.archlinux.org/code-server.git
-cd code-server
-makepkg -si
-systemctl --user enable --now code-server
-# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
-```
-
-### yarn, npm
-
-We recommend installing with `yarn` or `npm` if we don't have a precompiled release for your machine's
-platform or architecture or your glibc < v2.19.
-
-**note:** Installing via `yarn` or `npm` builds native modules on install and so requires C dependencies.
-See [./doc/npm.md](./doc/npm.md) for installing these dependencies.
-
-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
-```
-
-### Docker
-
-```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.
-docker run -it -p 127.0.0.1:8080:8080 \
-  -v "$PWD:/home/coder/project" \
-  -u "$(id -u):$(id -g)" \
-  codercom/code-server:latest
-```
-
-### Static Releases
-
-We publish self contained `.tar.gz` archives for every release on [github](https://github.com/cdr/code-server/releases).
-They bundle the node binary and node_modules.
-
-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`.
-
-Add the code-server `bin` directory to your `$PATH` to easily execute `code-server` without the full path every time.
-
-Here is an example script for installing and using a static `code-server` release on Linux:
-
-```bash
-curl -sSL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-linux-amd64.tar.gz \
-  | sudo tar -C /usr/local -xz
-sudo mv /usr/local/code-server-3.3.1-linux-amd64 /usr/local/code-server-3.3.1
-PATH="/usr/local/code-server-3.3.1/bin:$PATH"
-code-server
-# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
-```
 
 ## FAQ
 

ci/README.md

@@ -14,7 +14,9 @@ Any file or directory in this subdirectory should be documented here.
 
 Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) installed.
 
-1. Update the version of code-server in `package.json` and README.md/guide.md install examples and make a PR.
+1. Update the version of code-server and make a PR.
+   1. Update in `package.json`
+   2. Update in [install.sh](../install.sh)
 2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.
 3. Run `yarn release:github-draft` to create a GitHub draft release from the template with
    the updated version.
@@ -72,24 +74,24 @@ You can disable minification by setting `MINIFY=`.
   - Builds vscode into `./lib/vscode/out-vscode`.
 - [./ci/build/build-release.sh](./build/build-release.sh) (`yarn release`)
   - Bundles the output of the above two scripts into a single node module at `./release`.
-- [./ci/build/build-static-release.sh](./build/build-static-release.sh) (`yarn release:static`)
+- [./ci/build/build-standalone-release.sh](./build/build-standalone-release.sh) (`yarn release:standalone`)
   - Requires a node module already built into `./release` with the above script.
-  - Will build a static release with node and node_modules bundled into `./release-static`.
+  - Will build a standalone release with node and node_modules bundled into `./release-standalone`.
 - [./ci/build/clean.sh](./build/clean.sh) (`yarn clean`)
   - Removes all build artifacts.
   - Will also `git reset --hard lib/vscode`.
   - Useful to do a clean build.
 - [./ci/build/code-server.sh](./build/code-server.sh)
-  - Copied into static releases to run code-server with the bundled node binary.
+  - Copied into standalone releases to run code-server with the bundled node binary.
-- [./ci/build/test-static-release.sh](./build/test-static-release.sh) (`yarn test:static-release`)
+- [./ci/build/test-standalone-release.sh](./build/test-standalone-release.sh) (`yarn test:standalone-release`)
-  - Ensures code-server in the `./release-static` directory works by installing an extension.
+  - Ensures code-server in the `./release-standalone` directory works by installing an extension.
 - [./ci/build/build-packages.sh](./build/build-packages.sh) (`yarn package`)
-  - Packages `./release-static` into a `.tar.gz` archive in `./release-packages`.
+  - Packages `./release-standalone` into a `.tar.gz` archive in `./release-packages`.
   - If on linux, [nfpm](https://github.com/goreleaser/nfpm) is used to generate `.deb` and `.rpm`.
 - [./ci/build/nfpm.yaml](./build/nfpm.yaml)
   - Used to configure [nfpm](https://github.com/goreleaser/nfpm) to generate `.deb` and `.rpm`.
 - [./ci/build/code-server-nfpm.sh](./build/code-server-nfpm.sh)
-  - Entrypoint script for code-server for `.deb` and .rpm`.
+  - Entrypoint script for code-server for `.deb` and `.rpm`.
 - [./ci/build/code-server.service](./build/code-server.service)
   - systemd user service packaged into the `.deb` and `.rpm`.
 - [./ci/build/release-github-draft.sh](./build/release-github-draft.sh) (`yarn release:github-draft`)
@@ -128,9 +130,9 @@ Helps avoid clobbering the CI configuration.
 - [./steps/release.sh](./steps/release.sh)
   - Runs the release process.
   - Generates the npm package at `./release`.
-- [./steps/release-static.sh](./steps/release-static.sh)
+- [./steps/release-packages.sh](./steps/release-packages.sh)
-  - Takes the output of the previous script and generates a static release and
+  - Takes the output of the previous script and generates a standalone release and
-    release packages into `release-packages`.
+    release packages into `./release-packages`.
 - [./steps/publish-npm.sh](./steps/publish-npm.sh)
   - Grabs the `npm-package` release artifact for the current commit and publishes it on npm.
 - [./steps/build-docker-image.sh](./steps/build-docker-image.sh)

ci/build/build-code-server.sh

@@ -9,7 +9,7 @@ MINIFY=${MINIFY-true}
 main() {
   cd "$(dirname "${0}")/../.."
 
-  npx tsc --outDir out --tsBuildInfoFile .cache/out.tsbuildinfo
+  tsc --outDir out --tsBuildInfoFile .cache/out.tsbuildinfo
   # If out/node/entry.js does not already have the shebang,
   # we make sure to add it and make it executable.
   if ! grep -q -m1 "^#!/usr/bin/env node" out/node/entry.js; then
@@ -17,7 +17,7 @@ main() {
     chmod +x out/node/entry.js
   fi
 
-  npx parcel build \
+  parcel build \
     --public-url "/static/$(git rev-parse HEAD)/dist" \
     --out-dir dist \
     $([[ $MINIFY ]] || echo --no-minify) \

ci/build/build-packages.sh

@@ -2,7 +2,7 @@
 set -euo pipefail
 
 # Packages code-server for the current OS and architecture into ./release-packages.
-# This script assumes that a static release is built already into ./release-static.
+# This script assumes that a standalone release is built already into ./release-standalone
 
 main() {
   cd "$(dirname "${0}")/../.."
@@ -11,13 +11,17 @@ main() {
   mkdir -p release-packages
 
   release_archive
-  if [[ $OS == linux && $ARCH == "amd64" ]]; then
+  # Will stop the auto update issues and allow people to upgrade their scripts
-    # Will stop most of the auto update issues.
+  # for the new release structure.
-    # For the other releases it's more important to not pollute the release listing.
+  if [[ $ARCH == "amd64" ]]; then
+    if [[ $OS == "linux" ]]; then
       ARCH=x86_64 release_archive
+    elif [[ $OS == "macos" ]]; then
+      OS=darwin ARCH=x86_64 release_archive
+    fi
   fi
 
-  if [[ $OSTYPE == linux* ]]; then
+  if [[ $OS == "linux" ]]; then
     release_nfpm
   fi
 }
@@ -25,9 +29,9 @@ main() {
 release_archive() {
   local release_name="code-server-$VERSION-$OS-$ARCH"
   if [[ $OS == "linux" ]]; then
-    tar -czf "release-packages/$release_name.tar.gz" --transform "s/^\.\/release-static/$release_name/" ./release-static
+    tar -czf "release-packages/$release_name.tar.gz" --transform "s/^\.\/release-standalone/$release_name/" ./release-standalone
   else
-    tar -czf "release-packages/$release_name.tar.gz" -s "/^release-static/$release_name/" release-static
+    tar -czf "release-packages/$release_name.tar.gz" -s "/^release-standalone/$release_name/" release-standalone
   fi
   echo "done (release-packages/$release_name)"
 
@@ -44,7 +48,7 @@ release_gcp() {
 # Generates deb and rpm packages.
 release_nfpm() {
   local nfpm_config
-  nfpm_config=$(envsubst < ./ci/build/nfpm.yaml)
+  nfpm_config="$(envsubst < ./ci/build/nfpm.yaml)"
 
   # The underscores are convention for .deb.
   nfpm pkg -f <(echo "$nfpm_config") --target "release-packages/code-server_${VERSION}_$ARCH.deb"

ci/build/build-standalone-release.sh

@@ -5,8 +5,8 @@ main() {
   cd "$(dirname "${0}")/../.."
   source ./ci/lib.sh
 
-  rsync "$RELEASE_PATH/" "$RELEASE_PATH-static"
+  rsync "$RELEASE_PATH/" "$RELEASE_PATH-standalone"
-  RELEASE_PATH+=-static
+  RELEASE_PATH+=-standalone
 
   # We cannot find the path to node from $PATH because yarn shims a script to ensure
   # we use the same version it's using so we instead run a script with yarn that
@@ -17,6 +17,14 @@ main() {
   mkdir -p "$RELEASE_PATH/bin"
   rsync ./ci/build/code-server.sh "$RELEASE_PATH/bin/code-server"
   rsync "$node_path" "$RELEASE_PATH/lib/node"
+  if [[ $OS == "linux" ]]; then
+    bundle_dynamic_lib libstdc++
+    bundle_dynamic_lib libgcc_s
+  elif [[ $OS == "macos" ]]; then
+    bundle_dynamic_lib libicui18n
+    bundle_dynamic_lib libicuuc
+    bundle_dynamic_lib libicudata
+  fi
 
   ln -s "./bin/code-server" "$RELEASE_PATH/code-server"
   ln -s "./lib/node" "$RELEASE_PATH/node"
@@ -25,4 +33,17 @@ main() {
   yarn --production --frozen-lockfile
 }
 
+bundle_dynamic_lib() {
+  local lib_name="$1"
+  local lib_path
+
+  if [[ $OS == "linux" ]]; then
+    lib_path="$(ldd "$RELEASE_PATH/lib/node" | grep "$lib_name" | awk '{print $3 }')"
+  elif [[ $OS == "macos" ]]; then
+    lib_path="$(otool -L "$RELEASE_PATH/lib/node" | grep "$lib_name" | awk '{print $1 }')"
+  fi
+
+  cp "$lib_path" "$RELEASE_PATH/lib"
+}
+
 main "$@"

ci/build/clean.sh

@@ -8,7 +8,7 @@ main() {
   rm -Rf \
     out \
     release \
-    release-static \
+    release-standalone \
     release-packages \
     release-gcp \
     release-images/ \

ci/build/code-server.sh

@@ -1,7 +1,7 @@
-#!/usr/bin/env sh
+#!/bin/sh
 
-# This script is intended to be bundled into the static releases.
+# This script is intended to be bundled into the standalone releases.
-# Runs code-server with the bundled Node binary.
+# Runs code-server with the bundled node binary.
 
 # More complicated than readlink -f or realpath to support macOS.
 # See https://github.com/cdr/code-server/issues/1537
@@ -17,4 +17,9 @@ bin_dir() {
 }
 
 BIN_DIR=$(bin_dir)
+if [ "$(uname)" = "Linux" ]; then
+  export LD_LIBRARY_PATH="$BIN_DIR/../lib${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH}"
+elif [ "$(uname)" = "Darwin" ]; then
+  export DYLD_LIBRARY_PATH="$BIN_DIR/../lib${DYLD_LIBRARY_PATH+:$DYLD_LIBRARY_PATH}"
+fi
 exec "$BIN_DIR/../lib/node" "$BIN_DIR/.." "$@"

ci/build/nfpm.yaml

@@ -10,8 +10,7 @@ description: |
 vendor: "Coder"
 homepage: "https://github.com/cdr/code-server"
 license: "MIT"
-bindir: "/usr/bin"
 files:
   ./ci/build/code-server-nfpm.sh: /usr/bin/code-server
   ./ci/build/code-server.service: /usr/lib/systemd/user/code-server.service
-  ./release-static/**/*: "/usr/lib/code-server/"
+  ./release-standalone/**/*: "/usr/lib/code-server/"

ci/build/test-standalone-release.sh

@@ -10,18 +10,18 @@ main() {
   local EXTENSIONS_DIR
   EXTENSIONS_DIR="$(mktemp -d)"
 
-  echo "Testing static release"
+  echo "Testing standalone release."
 
-  ./release-static/bin/code-server --extensions-dir "$EXTENSIONS_DIR" --install-extension ms-python.python
+  ./release-standalone/bin/code-server --extensions-dir "$EXTENSIONS_DIR" --install-extension ms-python.python
   local installed_extensions
-  installed_extensions="$(./release-static/bin/code-server --extensions-dir "$EXTENSIONS_DIR" --list-extensions 2>&1)"
+  installed_extensions="$(./release-standalone/bin/code-server --extensions-dir "$EXTENSIONS_DIR" --list-extensions 2>&1)"
   if [[ $installed_extensions != "ms-python.python" ]]; then
     echo "Unexpected output from listing extensions:"
     echo "$installed_extensions"
     exit 1
   fi
 
-  echo "Static release works correctly"
+  echo "Standalone release works correctly."
 }
 
 main "$@"

ci/container/Dockerfile

@@ -6,11 +6,11 @@ RUN apt-get update
 RUN apt-get install -y curl gnupg
 
 # Installs node.
-RUN curl -sSL https://deb.nodesource.com/setup_14.x | bash - && \
+RUN curl -fsSL https://deb.nodesource.com/setup_14.x | bash - && \
     apt-get install -y nodejs
 
 # Installs yarn.
-RUN curl -sSL https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
+RUN curl -fsSL https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
     echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
     apt-get update && apt-get install -y yarn
 
@@ -28,23 +28,23 @@ RUN apt-get install -y git rsync unzip
 
 # We need latest jq from debian buster for date support.
 RUN ARCH="$(dpkg --print-architecture)" && \
-    curl -sSOL http://http.us.debian.org/debian/pool/main/libo/libonig/libonig5_6.9.1-1_$ARCH.deb && \
+    curl -fsSOL http://http.us.debian.org/debian/pool/main/libo/libonig/libonig5_6.9.1-1_$ARCH.deb && \
     dpkg -i libonig*.deb && \
-    curl -sSOL http://http.us.debian.org/debian/pool/main/j/jq/libjq1_1.5+dfsg-2+b1_$ARCH.deb && \
+    curl -fsSOL http://http.us.debian.org/debian/pool/main/j/jq/libjq1_1.5+dfsg-2+b1_$ARCH.deb && \
     dpkg -i libjq*.deb && \
-    curl -sSOL http://http.us.debian.org/debian/pool/main/j/jq/jq_1.5+dfsg-2+b1_$ARCH.deb && \
+    curl -fsSOL http://http.us.debian.org/debian/pool/main/j/jq/jq_1.5+dfsg-2+b1_$ARCH.deb && \
     dpkg -i jq*.deb && rm *.deb
 
 # Installs shellcheck.
 # Unfortunately coredumps on debian:8 so disabled for now.
-#RUN curl -sSL https://github.com/koalaman/shellcheck/releases/download/v0.7.1/shellcheck-v0.7.1.linux.$(uname -m).tar.xz | \
+#RUN curl -fsSL https://github.com/koalaman/shellcheck/releases/download/v0.7.1/shellcheck-v0.7.1.linux.$(uname -m).tar.xz | \
 #    tar -xJ && \
 #    mv shellcheck*/shellcheck /usr/local/bin && \
 #    rm -R shellcheck*
 
 # Install Go dependencies
 RUN ARCH="$(dpkg --print-architecture)" && \
-    curl -sSL "https://dl.google.com/go/go1.14.3.linux-$ARCH.tar.gz" | tar -C /usr/local -xz
+    curl -fsSL "https://dl.google.com/go/go1.14.3.linux-$ARCH.tar.gz" | tar -C /usr/local -xz
 ENV PATH=/usr/local/go/bin:/root/go/bin:$PATH
 ENV GO111MODULE=on
 RUN go get mvdan.cc/sh/v3/cmd/shfmt

ci/container/arm64/Dockerfile

@@ -6,11 +6,11 @@ RUN apt-get update
 RUN apt-get install -y curl gnupg
 
 # Installs node.
-RUN curl -sSL https://deb.nodesource.com/setup_14.x | bash - && \
+RUN curl -fsSL https://deb.nodesource.com/setup_14.x | bash - && \
     apt-get install -y nodejs
 
 # Installs yarn.
-RUN curl -sSL https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
+RUN curl -fsSL https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
     echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
     apt-get update && apt-get install -y yarn
 
@@ -24,27 +24,27 @@ RUN apt-get install -y build-essential \
 RUN apt-get install -y gettext-base
 
 # Misc build dependencies.
-RUN apt-get install -y git rsync
+RUN apt-get install -y git rsync unzip
 
 # We need latest jq from debian buster for date support.
 RUN ARCH="$(dpkg --print-architecture)" && \
-    curl -sSOL http://http.us.debian.org/debian/pool/main/libo/libonig/libonig5_6.9.1-1_$ARCH.deb && \
+    curl -fsSOL http://http.us.debian.org/debian/pool/main/libo/libonig/libonig5_6.9.1-1_$ARCH.deb && \
     dpkg -i libonig*.deb && \
-    curl -sSOL http://http.us.debian.org/debian/pool/main/j/jq/libjq1_1.5+dfsg-2+b1_$ARCH.deb && \
+    curl -fsSOL http://http.us.debian.org/debian/pool/main/j/jq/libjq1_1.5+dfsg-2+b1_$ARCH.deb && \
     dpkg -i libjq*.deb && \
-    curl -sSOL http://http.us.debian.org/debian/pool/main/j/jq/jq_1.5+dfsg-2+b1_$ARCH.deb && \
+    curl -fsSOL http://http.us.debian.org/debian/pool/main/j/jq/jq_1.5+dfsg-2+b1_$ARCH.deb && \
     dpkg -i jq*.deb && rm *.deb
 
 # Installs shellcheck.
 # Unfortunately coredumps on debian:8 so disabled for now.
-#RUN curl -sSL https://github.com/koalaman/shellcheck/releases/download/v0.7.1/shellcheck-v0.7.1.linux.$(uname -m).tar.xz | \
+#RUN curl -fsSL https://github.com/koalaman/shellcheck/releases/download/v0.7.1/shellcheck-v0.7.1.linux.$(uname -m).tar.xz | \
 #    tar -xJ && \
 #    mv shellcheck*/shellcheck /usr/local/bin && \
 #    rm -R shellcheck*
 
 # Install Go dependencies
 RUN ARCH="$(dpkg --print-architecture)" && \
-    curl -sSL "https://dl.google.com/go/go1.14.3.linux-$ARCH.tar.gz" | tar -C /usr/local -xz
+    curl -fsSL "https://dl.google.com/go/go1.14.3.linux-$ARCH.tar.gz" | tar -C /usr/local -xz
 ENV PATH=/usr/local/go/bin:/root/go/bin:$PATH
 ENV GO111MODULE=on
 RUN go get mvdan.cc/sh/v3/cmd/shfmt

ci/dev/fmt.sh

@@ -23,6 +23,7 @@ main() {
 
   doctoc --title '# FAQ' doc/FAQ.md > /dev/null
   doctoc --title '# Setup Guide' doc/guide.md > /dev/null
+  doctoc --title '# Install' doc/install.md > /dev/null
 
   if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
     echo "Files need generation or are formatted incorrectly:"

ci/dev/lint.sh

@@ -9,7 +9,7 @@ main() {
   tsc --noEmit
   # See comment in ./ci/container/Dockerfile
   if [[ ! ${CI-} ]]; then
-    shellcheck -e SC2046,SC2164,SC2154 $(git ls-files "*.sh")
+    shellcheck -e SC2046,SC2164,SC2154,SC1091,SC1090 $(git ls-files "*.sh")
   fi
 }
 

ci/lib.sh

@@ -56,14 +56,14 @@ curl() {
 # This will contain the artifacts we want.
 # https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs
 get_artifacts_url() {
-  curl -sSL 'https://api.github.com/repos/cdr/code-server/actions/workflows/ci.yaml/runs?status=success&event=push' | jq -r ".workflow_runs[] | select(.head_sha == \"$(git rev-parse HEAD)\") | .artifacts_url" | head -n 1
+  curl -fsSL 'https://api.github.com/repos/cdr/code-server/actions/workflows/ci.yaml/runs?status=success&event=push' | jq -r ".workflow_runs[] | select(.head_sha == \"$(git rev-parse HEAD)\") | .artifacts_url" | head -n 1
 }
 
 # Grabs the artifact's download url.
 # https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts
 get_artifact_url() {
   local artifact_name="$1"
-  curl -sSL "$(get_artifacts_url)" | jq -r ".artifacts[] | select(.name == \"$artifact_name\") | .archive_download_url" | head -n 1
+  curl -fsSL "$(get_artifacts_url)" | jq -r ".artifacts[] | select(.name == \"$artifact_name\") | .archive_download_url" | head -n 1
 }
 
 # Uses the above two functions to download a artifact into a directory.
@@ -74,7 +74,7 @@ download_artifact() {
   local tmp_file
   tmp_file="$(mktemp)"
 
-  curl -sSL "$(get_artifact_url "$artifact_name")" > "$tmp_file"
+  curl -fsSL "$(get_artifact_url "$artifact_name")" > "$tmp_file"
   unzip -q -o "$tmp_file" -d "$dst"
   rm "$tmp_file"
 }

ci/release-container/Dockerfile

@@ -28,7 +28,7 @@ RUN adduser --gecos '' --disabled-password coder && \
   echo "coder ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd
 
 RUN ARCH="$(dpkg --print-architecture)" && \
-    curl -sSL "https://github.com/boxboat/fixuid/releases/download/v0.4.1/fixuid-0.4.1-linux-$ARCH.tar.gz" | tar -C /usr/local/bin -xzf - && \
+    curl -fsSL "https://github.com/boxboat/fixuid/releases/download/v0.4.1/fixuid-0.4.1-linux-$ARCH.tar.gz" | tar -C /usr/local/bin -xzf - && \
     chown root:root /usr/local/bin/fixuid && \
     chmod 4755 /usr/local/bin/fixuid && \
     mkdir -p /etc/fixuid && \

ci/steps/release-packages.sh

@@ -7,8 +7,8 @@ main() {
   # https://github.com/actions/upload-artifact/issues/38
   tar -xzf release-npm-package/package.tar.gz
 
-  yarn release:static
+  yarn release:standalone
-  yarn test:static-release
+  yarn test:standalone-release
   yarn package
 }
 

doc/CONTRIBUTING.md

@@ -51,14 +51,14 @@ yarn --production
 node .
 ```
 
-Now you can make it static and build packages with:
+Now you can build release packages with:
 
 ```
-yarn release:static
+yarn release:standalone
-yarn test:static-release
+# The standalone release is in ./release-standalone
+yarn test:standalone-release
 yarn package
-# The static release is in ./release-static
+# .deb, .rpm and the standalone archive are in ./release-packages
-# .deb, .rpm and the static archive are in ./release-packages
 ```
 
 ## Structure

doc/FAQ.md

@@ -8,10 +8,10 @@
 - [How is this different from VS Code Codespaces?](#how-is-this-different-from-vs-code-codespaces)
 - [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet)
 - [How do I securely access web services?](#how-do-i-securely-access-web-services)
-  - [Sub-domains](#sub-domains)
   - [Sub-paths](#sub-paths)
+  - [Sub-domains](#sub-domains)
 - [Multi-tenancy](#multi-tenancy)
-- [Docker in code-server docker container?](#docker-in-code-server-docker-container)
+- [Docker in code-server container?](#docker-in-code-server-container)
 - [Collaboration](#collaboration)
 - [How can I disable telemetry?](#how-can-i-disable-telemetry)
 - [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open)
@@ -19,6 +19,9 @@
 - [Heartbeat File](#heartbeat-file)
 - [How does the config file work?](#how-does-the-config-file-work)
 - [Blank screen on iPad?](#blank-screen-on-ipad)
+- [Isn't an install script piped into sh insecure?](#isnt-an-install-script-piped-into-sh-insecure)
+- [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work)
+- [Why can't I use VS Code's Remote extensions?](#why-cant-i-use-vs-codes-remote-extensions)
 - [Enterprise](#enterprise)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -39,23 +42,23 @@ See https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visual-Studio-
 > Marketplace Offerings are intended for use only with Visual Studio Products and Services
 > and you may only install and use Marketplace Offerings with Visual Studio Products and Services.
 
-As a result, Coder has created its own marketplace for open source extensions. It works by scraping
+As a result, we have created our own marketplace for open source extensions.
-GitHub for VS Code extensions and building them. It's not perfect but getting better by the day with
+It works by scraping GitHub for VS Code extensions and building them. It's not perfect but getting
-more and more extensions.
+better by the day with more and more extensions.
 
 Issue [#1299](https://github.com/cdr/code-server/issues/1299) is a big one in making the experience here
 better by allowing the community to submit extensions and repos to avoid waiting until the scraper finds
 an extension.
 
+To request an extension for the code-server marketplace, please open a new issue
+and select the `Extension request` template.
+
 If an extension is not available or does not work, you can grab its VSIX from its Github releases or
 build it yourself. Then run the `Extensions: Install from VSIX` command in the Command Palette and
 point to the .vsix file.
 
 See below for installing an extension from the cli.
 
-To request an extension for the code-server marketplace, please open a new issue
-and select the `Extension request` template.
-
 If you have your own custom marketplace, it is possible to point code-server to it by setting
 `$SERVICE_URL` and `$ITEM_URL` to point to it.
 
@@ -96,17 +99,17 @@ code-server only supports password authentication natively.
 **note**: code-server will rate limit password authentication attempts at 2 a minute and 12 an hour.
 
 If you want to use external authentication (i.e sign in with Google) you should handle this
-with a reverse proxy using something like [oauth2_proxy](https://github.com/pusher/oauth2_proxy).
+with a reverse proxy using something like [oauth2_proxy](https://github.com/pusher/oauth2_proxy)
+or [Cloudflare Access](https://teams.cloudflare.com/access).
 
 For HTTPS, you can use a self signed certificate by passing in just `--cert` or
 pass in an existing certificate by providing the path to `--cert` and the path to
-its key with `--cert-key`.
+the key with `--cert-key`.
 
 If `code-server` has been passed a certificate it will also respond to HTTPS
-requests and will redirect all HTTP requests to HTTPS. Otherwise it will respond
+requests and will redirect all HTTP requests to HTTPS.
-only to HTTP requests.
 
-You can use [Let's Encrypt](https://letsencrypt.org/) to get an SSL certificate
+You can use [Let's Encrypt](https://letsencrypt.org/) to get a TLS certificate
 for free.
 
 Again, please follow [./guide.md](./guide.md) for our recommendations on setting up and using code-server.
@@ -117,6 +120,10 @@ code-server is capable of proxying to any port using either a subdomain or a
 subpath which means you can securely access these services using code-server's
 built-in authentication.
 
+### Sub-paths
+
+Just browse to `/proxy/<port>/`.
+
 ### Sub-domains
 
 You will need a DNS entry that points to your server for each port you want to
@@ -136,35 +143,28 @@ code-server --proxy-domain <domain>
 Now you can browse to `<port>.<domain>`. Note that this uses the host header so
 ensure your reverse proxy forwards that information if you are using one.
 
-### Sub-paths
-
-Just browse to `/proxy/<port>/`.
-
 ## Multi-tenancy
 
 If you want to run multiple code-servers on shared infrastructure, we recommend using virtual
 machines with a VM per user. This will easily allow users to run a docker daemon. If you want
 to use kubernetes, you'll definitely want to use [kubevirt](https://kubevirt.io) to give each
-user a virtual machine instead of just a container. Docker in docker while supported requires
+user a virtual machine instead of just a container.
-privileged containers which are a security risk in a multi tenant infrastructure.
 
-## Docker in code-server docker container?
+## Docker in code-server container?
 
-If you'd like to access docker inside of code-server, we'd recommend running a docker:dind container
+If you'd like to access docker inside of code-server, mount the docker socket in from `/var/run/docker.sock`.
-and mounting in a directory to share between dind and the code-server container at /var/run. After, install
+Install the docker CLI in the code-server container and you should be able to access the daemon!
-the docker CLI in the code-server container and you should be able to access the daemon as the socket
-will be shared at /var/run/docker.sock.
 
-In order to make volume mounts work, mount the home directory in the code-server container and the
+You can even make volume mounts work. Lets say you want to run a container and mount in
-dind container at the same path. i.e you'd volume mount a directory from the host to `/home/coder`
+`/home/coder/myproject` into it from inside the `code-server` container. You need to make sure
-on both. This will allow any volume mounts in the home directory to work. Similar process
+the docker daemon's `/home/coder/myproject` is the same as the one mounted inside the `code-server`
-to make volume mounts in any other directory work.
+container and the mount will just work.
 
 ## Collaboration
 
 We understand the high demand but the team is swamped right now.
 
-You can follow progress at [#33](https://github.com/cdr/code-server/issues/33).
+You can subscribe to [#33](https://github.com/cdr/code-server/issues/33) for updates.
 
 ## How can I disable telemetry?
 
@@ -207,7 +207,7 @@ as there is an active browser connection.
 
 If you want to shutdown `code-server` if there hasn't been an active connection in X minutes
 you can do so by continuously checking the last modified time on the heartbeat file and if it is
-older than X minutes, you should kill `code-server`.
+older than X minutes, kill `code-server`.
 
 [#1636](https://github.com/cdr/code-server/issues/1636) will make the experience here better.
 
@@ -242,6 +242,33 @@ certificate using the CA and then import the CA onto your iPad.
 
 See [#1566](https://github.com/cdr/code-server/issues/1566#issuecomment-623159434).
 
+## Isn't an install script piped into sh 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.
+
+## How do I make my keyboard shortcuts work?
+
+Many shortcuts will not work by default as they'll be caught by the browser.
+
+If you use Chrome you can get around this by installing the PWA.
+
+Once you've entered the editor, click the "plus" icon present in the URL toolbar area.
+This will install a Chrome PWA and now all keybindings will work!
+
+For other browsers you'll have to remap keybindings unfortunately.
+
+## Why can't I use VS Code's Remote extensions?
+
+Unfortunately, Microsoft has opted to make [VS Code's Remote SSH and Container
+extensions closed source](https://github.com/microsoft/vscode-remote-release) and
+it is against their TOS to use the published extensions so we are unable to
+add them to our marketplace.
+
+We may reimplement them at some point.
+You can subscribe to [#1315](https://github.com/cdr/code-server/issues/1315) for updates.
+
 ## Enterprise
 
 Visit [our enterprise page](https://coder.com) for more information about our

doc/guide.md

@@ -15,21 +15,22 @@
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-This guide demonstrates how to setup and use code-server.
+This guide demonstrates how to setup and use `code-server`.
-To reiterate, code-server lets you run VS Code on a remote server and then access it via a browser.
+To reiterate, `code-server` lets you run VS Code on a remote server and then access it via a browser.
 
 Further docs are at:
 
-- [README.md](../README.md) for a general overview
+- [README](../README.md) for a general overview
-- [FAQ.md](./FAQ.md) for common questions.
+- [INSTALL](../doc/install.md) for installation
-- [CONTRIBUTING.md](../doc/CONTRIBUTING.md) for development docs
+- [FAQ](./FAQ.md) for common questions.
+- [CONTRIBUTING](../doc/CONTRIBUTING.md) for development docs
 
-We'll walk you through acquiring a remote machine to run code-server on and then exposing `code-server` so you can
+We'll walk you through acquiring a remote machine to run `code-server` on
-securely access it.
+and then exposing `code-server` so you can securely access it.
 
 ## 1. Acquire a remote machine
 
-First, you need a machine to run code-server on. You can use a physical
+First, you need a machine to run `code-server` on. You can use a physical
 machine you have lying around or use a VM on GCP/AWS.
 
 ### Requirements
@@ -60,66 +61,71 @@ Once you've signed up and created a GCP project, create a new Compute Engine VM
    - Change the type to custom and set at least 2 cores and 2 GB of ram.
    - Add more vCPUs and memory as you prefer, you can edit after creating the instance as well.
    - https://cloud.google.com/compute/docs/machine-types#general_purpose
-7. We highly recommend switching the persistent disk to a SSD of at least 32 GB.
+7. We highly recommend switching the persistent disk to an SSD of at least 32 GB.
    - Click `Change` under `Boot Disk` and change the type to `SSD Persistent Disk` and the size
      to `32`.
    - You can always grow your disk later.
-   - The default OS of Debian 10 is fine.
 8. Navigate to `Networking -> Network interfaces` and edit the existing interface
    to use a static external IP.
    - Click done to save network interface changes.
-9. If you do not have a [project wide SSH key](https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys#project-wide), navigate to `Security - > SSH Keys` and add your public key there.
+9. If you do not have a [project wide SSH key](https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys#project-wide), navigate to `Security -> SSH Keys` and add your public key there.
 10. Click create!
 
 Remember, you can shutdown your server when not in use to lower costs.
+
 We highly recommend learning to use the [`gcloud`](https://cloud.google.com/sdk/gcloud) cli
 to avoid the slow dashboard.
 
 ## 2. Install code-server
 
-SSH into your instance and run the appropriate commands documented in [README.md](../README.md).
+We have a [script](../install.sh) to install `code-server` for Linux and macOS.
 
-Assuming Debian:
+It tries to use the system package manager if possible.
+
+First run to print out the install process:
 
 ```bash
-curl -sSOL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server_3.3.1_amd64.deb
+curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
-sudo dpkg -i code-server_3.3.1_amd64.deb
-systemctl --user enable --now code-server
-# Now code-server is running at http://127.0.0.1:8080
-# Your password is in ~/.config/code-server/config.yaml
 ```
 
+Now to actually install:
+
+```bash
+curl -fsSL https://code-server.dev/install.sh | sh
+```
+
+The install script will print out how to run and start using `code-server`.
+
+Docs on the install script, manual installation and docker image are at [./install.md](./install.md).
+
 ## 3. Expose code-server
 
 **Never**, **ever** expose `code-server` directly to the internet without some form of authentication
 and encryption as someone can completely takeover your machine with the terminal.
 
-By default, code-server will enable password authentication which will
+By default, `code-server` will enable password authentication which will require you to copy the
-require you to copy the password from the code-server config file to login. Since it
+password from the`code-server`config file to login. It will listen on`localhost` to avoid exposing
-cannot use TLS by default, it will listen on `localhost` to avoid exposing itself
+itself to the world. This is fine for testing but will not work if you want to access `code-server`
-to the world. This is fine for testing but will not work if you want to access `code-server`
 from a different machine.
 
-There are several approaches to securely operating and exposing code-server.
+There are several approaches to securely operating and exposing `code-server`.
 
-**tip**: You can list the full set of code-server options with `code-server --help`
+**tip**: You can list the full set of `code-server` options with `code-server --help`
 
 ### SSH forwarding
 
 We highly recommend this approach for not requiring any additional setup, you just need an
 SSH server on your remote machine. The downside is you won't be able to access `code-server`
-without an SSH client like an iPad. If that's important to you, skip to [Let's Encrypt](#lets-encrypt).
+on any machine without an SSH client like on iPad. If that's important to you, skip to [Let's Encrypt](#lets-encrypt).
 
-Recommended reading: https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding.
+First, ssh into your instance and edit your `code-server` config file to disable password authentication.
-
-First, ssh into your instance and edit your code-server config file to disable password authentication.
 
 ```bash
 # Replaces "auth: password" with "auth: none" in the code-server config.
 sed -i.bak 's/auth: password/auth: none/' ~/.config/code-server/config.yaml
 ```
 
-Restart code-server with (assuming you followed the guide):
+Restart `code-server` with (assuming you followed the guide):
 
 ```bash
 systemctl --user restart code-server
@@ -127,12 +133,14 @@ systemctl --user restart code-server
 
 Now forward local port 8080 to `127.0.0.1:8080` on the remote instance.
 
+Recommended reading: https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding.
+
 ```bash
 # -N disables executing a remote shell
 ssh -N -L 8080:127.0.0.1:8080 <instance-ip>
 ```
 
-Now if you access http://127.0.0.1:8080 locally, you should see code-server!
+Now if you access http://127.0.0.1:8080 locally, you should see `code-server`!
 
 If you want to make the SSH port forwarding persistent we recommend using
 [mutagen](https://mutagen.io/documentation/introduction/installation).
@@ -151,16 +159,16 @@ ServerAliveInterval 5
 ExitOnForwardFailure yes
 ```
 
-You can also forward your SSH key and GPG agent to the instance to securely access GitHub
+You can also forward your SSH and GPG agent to the instance to securely access GitHub
-and sign commits without copying your keys onto the instance.
+and sign commits without copying your keys.
 
 1. https://developer.github.com/v3/guides/using-ssh-agent-forwarding/
 2. https://wiki.gnupg.org/AgentForwarding
 
 ### Let's Encrypt
 
-[Let's Encrypt](https://letsencrypt.org) is a great option if you want to access code-server on an iPad
+[Let's Encrypt](https://letsencrypt.org) is a great option if you want to access `code-server` on an iPad
-or do not want to use SSH forwarding. This does require that the remote machine is exposed to the internet.
+or do not want to use SSH forwarding. This does require that the remote machine be exposed to the internet.
 
 Assuming you have been following the guide, edit your instance and checkmark the allow HTTP/HTTPS traffic options.
 
@@ -189,25 +197,24 @@ reverse_proxy 127.0.0.1:8080
 sudo systemctl reload caddy
 ```
 
-Visit `https://<your-domain-name>` to access code-server. Congratulations!
+Visit `https://<your-domain-name>` to access `code-server`. Congratulations!
 
-In a future release we plan to integrate Let's Encrypt directly with code-server to avoid
+In a future release we plan to integrate Let's Encrypt directly with `code-server` to avoid
 the dependency on caddy.
 
 ### Self Signed Certificate
 
 **note:** Self signed certificates do not work with iPad and will cause a blank page. You'll
-have to use [Let's Encrypt](#lets-encrypt) instead. See the [FAQ](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#blank-screen-on-ipad).
+have to use [Let's Encrypt](#lets-encrypt) instead. See the [FAQ](./FAQ.md#blank-screen-on-ipad).
 
 Recommended reading: https://security.stackexchange.com/a/8112.
 
-We recommend this as a last resort as self signed certificates do not work with iPads and can
+We recommend this as a last resort because self signed certificates do not work with iPads and can
-cause other bizarre issues. Not to mention all the warnings when you access code-server.
+cause other bizarre issues. Not to mention all the warnings when you access `code-server`.
 Only use this if:
 
-1. You do not want to buy a domain.
+1. You do not want to buy a domain or you cannot expose the remote machine to the internet.
-2. You cannot expose the remote machine to the internet.
+2. You do not want to use SSH forwarding.
-3. You do not want to use SSH forwarding.
 
 ssh into your instance and edit your code-server config file to use a randomly generated self signed certificate:
 
@@ -220,7 +227,7 @@ sed -i.bak 's/bind-addr: 127.0.0.1:8080/bind-addr: 0.0.0.0:443/' ~/.config/code-
 sudo setcap cap_net_bind_service=+ep /usr/lib/code-server/lib/node
 ```
 
-Assuming you have been following the guide, restart code-server with:
+Assuming you have been following the guide, restart `code-server` with:
 
 ```bash
 systemctl --user restart code-server
@@ -228,17 +235,17 @@ systemctl --user restart code-server
 
 Edit your instance and checkmark the allow HTTPS traffic option.
 
-Visit `https://<your-instance-ip>` to access code-server.
+Visit `https://<your-instance-ip>` to access `code-server`.
 You'll get a warning when accessing but if you click through you should be good.
 
 To avoid the warnings, you can use [mkcert](https://mkcert.dev) to create a self signed certificate
-trusted by your OS and then pass it into code-server via the `cert` and `cert-key` config
+trusted by your OS and then pass it into `code-server` via the `cert` and `cert-key` config
 fields.
 
 ### Change the password?
 
-Edit the code-server config file at `~/.config/code-server/config.yaml` and then restart
+Edit the `password` field in the `code-server` config file at `~/.config/code-server/config.yaml`
-code-server with:
+and then restart `code-server` with:
 
 ```bash
 systemctl --user restart code-server
@@ -246,6 +253,6 @@ systemctl --user restart code-server
 
 ### How do I securely access development web services?
 
-If you're working on a web service and want to access it locally, code-server can proxy it for you.
+If you're working on a web service and want to access it locally, `code-server` can proxy it for you.
 
-See [FAQ.md](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-securely-access-web-services).
+See the [FAQ](./FAQ.md#how-do-i-securely-access-web-services).

doc/install.md

@@ -0,0 +1,185 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+# Install
+
+- [install.sh](#installsh)
+  - [Flags](#flags)
+  - [Detect Reference](#detect-reference)
+- [Debian, Ubuntu](#debian-ubuntu)
+- [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
+- [Arch Linux](#arch-linux)
+- [yarn, npm](#yarn-npm)
+- [macOS](#macos)
+- [Standalone Releases](#standalone-releases)
+- [Docker](#docker)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+This document demonstrates how to install `code-server` on
+various distros and operating systems.
+
+## install.sh
+
+We have a [script](../install.sh) to install code-server for Linux and macOS.
+
+It tries to use the system package manager if possible.
+
+First run to print out the install process:
+
+```bash
+curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
+```
+
+Now to actually install:
+
+```bash
+curl -fsSL https://code-server.dev/install.sh | sh
+```
+
+The script will print out how to run and start using code-server.
+
+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.
+
+If you'd still prefer manual installation despite the below [detect reference](#detect-reference) and `--dry-run`
+then continue on for docs on manual installation. The [`install.sh`](../install.sh) script runs the _exact_ same
+commands presented in the rest of this document.
+
+### Flags
+
+- `--dry-run` to echo the commands for the install process without running them.
+- `--method` to choose the installation method.
+  - `--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.
+- `--version=X.X.X` to install version `X.X.X` instead of latest.
+- `--help` to see full usage docs.
+
+### Detect Reference
+
+- For Debian, Ubuntu and Raspbian it will install the latest deb package.
+- For Fedora, CentOS, RHEL and openSUSE it will install the latest rpm package.
+- For Arch Linux it will install the AUR package.
+- For any unrecognized Linux operating system it will install the latest standalone release into `~/.local`.
+
+  - Add `~/.local/bin` to your `$PATH` to run code-server.
+
+- For macOS it will install the Homebrew package.
+
+  - If Homebrew is not installed it will install the latest standalone release into `~/.local`.
+  - Add `~/.local/bin` to your `$PATH` to run code-server.
+
+- If ran on an architecture with no releases, it will install the [npm package](#yarn-npm) with `yarn` or `npm`.
+  - We only have releases for amd64 and arm64 presently.
+  - The [npm package](#yarn-npm) builds the native modules on postinstall.
+
+## Debian, Ubuntu
+
+```bash
+curl -fOL https://github.com/cdr/code-server/releases/download/v3.4.0/code-server_3.4.0_amd64.deb
+sudo dpkg -i code-server_3.4.0_amd64.deb
+systemctl --user enable --now code-server
+# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
+```
+
+## Fedora, CentOS, RHEL, SUSE
+
+```bash
+curl -fOL https://github.com/cdr/code-server/releases/download/v3.4.0/code-server-3.4.0-amd64.rpm
+sudo rpm -i code-server-3.4.0-amd64.rpm
+systemctl --user enable --now code-server
+# 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
+systemctl --user enable --now code-server
+# 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
+systemctl --user enable --now code-server
+# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
+```
+
+## yarn, npm
+
+We recommend installing with `yarn` or `npm` when:
+
+1. You aren't on `amd64` or `arm64`.
+2. If you're on Linux with glibc < v2.17
+
+**note:** Installing via `yarn` or `npm` builds native modules on install and so requires C dependencies.
+See [./npm.md](./npm.md) for installing these dependencies.
+
+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
+```
+
+## Standalone Releases
+
+We publish self contained `.tar.gz` archives for every release on [github](https://github.com/cdr/code-server/releases).
+They bundle the node binary and `node_modules`.
+
+These are created from the [npm package](#yarn-npm) and the rest of the releases are created from these.
+Only requirement is glibc >= 2.17 on Linux and for macOS there is no minimum system requirement.
+
+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`.
+
+You can add the code-server `bin` directory to your `$PATH` to easily execute `code-server`
+without the full path every time.
+
+Here is an example script for installing and using a standalone `code-server` release on Linux:
+
+```bash
+mkdir -p ~/.local/lib ~/.local/bin
+curl -fL https://github.com/cdr/code-server/releases/download/v3.4.0/code-server-3.4.0-linux-amd64.tar.gz \
+  | tar -C ~/.local/lib -xz
+mv ~/.local/lib/code-server-3.4.0-linux-amd64 ~/.local/lib/code-server-3.4.0
+ln -s ~/.local/lib/code-server-3.4.0/bin/code-server ~/.local/bin/code-server
+PATH="~/.local/bin:$PATH"
+code-server
+# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
+```
+
+## Docker
+
+```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.
+docker run -it -p 127.0.0.1:8080:8080 \
+  -v "$PWD:/home/coder/project" \
+  -u "$(id -u):$(id -g)" \
+  codercom/code-server:latest
+```
+
+Our official image supports `amd64` and `arm64`.
+
+For `arm32` support there is a popular community maintained alternative:
+
+https://hub.docker.com/r/linuxserver/code-server

doc/npm.md

@@ -16,7 +16,7 @@ sudo apt-get install -y \
   libsecret-1-dev
 ```
 
-## Fedora, Red Hat, SUSE
+## Fedora, CentOS, RHEL
 
 ```bash
 sudo yum groupinstall -y 'Development Tools'

install.sh

@@ -0,0 +1,482 @@
+#!/bin/sh
+set -eu
+
+# code-server's automatic install script.
+# See https://github.com/cdr/code-server/blob/master/doc/install.md
+
+usage() {
+  arg0="$0"
+  if [ "$0" = sh ]; then
+    arg0="curl -fsSL https://code-server.dev/install.sh | sh -s --"
+  else
+    not_curl_usage="The latest script is available at https://code-server.dev/install.sh
+"
+  fi
+
+  cath << EOF
+Installs code-server for Linux and macOS.
+It tries to use the system package manager if possible.
+After successful installation it explains how to start using code-server.
+${not_curl_usage-}
+Usage:
+
+  $arg0 [--dry-run] [--version X.X.X] [--method detect] [--prefix ~/.local]
+
+  --dry-run
+      Echo the commands for the install process without running them.
+  --version X.X.X
+      Install a specific version instead of the latest.
+  --method [detect | standalone]
+      Choose the installation method. Defaults to detect.
+      - detect detects the system package manager and tries to use it.
+        Full reference on the process is further below.
+      - standalone installs a standalone release archive into ~/.local
+        Add ~/.local/bin to your \$PATH to use it.
+  --prefix <dir>
+      Sets the prefix used by standalone release archives. Defaults to ~/.local
+      The release is unarchived into ~/.local/lib/code-server-X.X.X
+      and the binary symlinked into ~/.local/bin/code-server
+      To install system wide pass ---prefix=/usr/local
+
+- For Debian, Ubuntu and Raspbian it will install the latest deb package.
+- For Fedora, CentOS, RHEL and openSUSE it will install the latest rpm package.
+- For Arch Linux it will install the AUR package.
+- For any unrecognized Linux operating system it will install the latest standalone
+  release into ~/.local
+
+- For macOS it will install the Homebrew package.
+  - If Homebrew is not installed it will install the latest standalone release
+    into ~/.local
+
+- If ran on an architecture with no releases, it will install the
+  npm package with yarn or npm.
+  - We only have releases for amd64 and arm64 presently.
+  - The npm package builds the native modules on postinstall.
+
+It will cache all downloaded assets into ~/.cache/code-server
+
+More installation docs are at https://github.com/cdr/code-server/blob/master/doc/install.md
+EOF
+}
+
+echo_latest_version() {
+  # https://gist.github.com/lukechilds/a83e1d7127b78fef38c2914c4ececc3c#gistcomment-2758860
+  version="$(curl -fsSLI -o /dev/null -w "%{url_effective}" https://github.com/cdr/code-server/releases/latest)"
+  version="${version#https://github.com/cdr/code-server/releases/tag/v}"
+  echo "$version"
+}
+
+echo_standalone_postinstall() {
+  echoh
+  cath << EOF
+Standalone release has been installed into $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION
+Please extend your path to use code-server:
+  PATH="$STANDALONE_INSTALL_PREFIX/bin:\$PATH"
+Then you can run:
+  code-server
+EOF
+}
+
+echo_systemd_postinstall() {
+  echoh
+  cath << EOF
+To have systemd start code-server now and restart on boot:
+  systemctl --user enable --now code-server
+Or, if you don't want/need a background service you can run:
+  code-server
+EOF
+}
+
+main() {
+  if [ "${TRACE-}" ]; then
+    set -x
+  fi
+
+  unset \
+    DRY_RUN \
+    METHOD \
+    STANDALONE_INSTALL_PREFIX \
+    VERSION \
+    OPTIONAL
+
+  while [ "$#" -gt 0 ]; do
+    case "$1" in
+    --dry-run)
+      DRY_RUN=1
+      ;;
+    --method)
+      METHOD="$(parse_arg "$@")"
+      shift
+      ;;
+    --method=*)
+      METHOD="$(parse_arg "$@")"
+      ;;
+    --prefix)
+      STANDALONE_INSTALL_PREFIX="$(parse_arg "$@")"
+      shift
+      ;;
+    --prefix=*)
+      STANDALONE_INSTALL_PREFIX="$(parse_arg "$@")"
+      ;;
+    --version)
+      VERSION="$(parse_arg "$@")"
+      shift
+      ;;
+    --version=*)
+      VERSION="$(parse_arg "$@")"
+      ;;
+    -h | --h | -help | --help)
+      usage
+      exit 0
+      ;;
+    *)
+      echoerr "Unknown flag $1"
+      echoerr "Run with --help to see usage."
+      exit 1
+      ;;
+    esac
+
+    shift
+  done
+
+  VERSION="${VERSION-$(echo_latest_version)}"
+  METHOD="${METHOD-detect}"
+  if [ "$METHOD" != detect ] && [ "$METHOD" != standalone ]; then
+    echoerr "Unknown install method \"$METHOD\""
+    echoerr "Run with --help to see usage."
+    exit 1
+  fi
+  STANDALONE_INSTALL_PREFIX="${STANDALONE_INSTALL_PREFIX-$HOME/.local}"
+
+  OS="$(os)"
+  if [ ! "$OS" ]; then
+    echoerr "Unsupported OS $(uname)."
+    exit 1
+  fi
+
+  distro_name
+
+  ARCH="$(arch)"
+  if [ ! "$ARCH" ]; then
+    if [ "$METHOD" = standalone ]; then
+      echoerr "No releases available for the architecture $(uname -m)."
+      echoerr 'Please rerun without the "--method standalone" flag to install from npm.'
+      exit 1
+    fi
+    echoh "No precompiled releases for $(uname -m)."
+    install_npm
+    return
+  fi
+
+  CACHE_DIR="$(echo_cache_dir)"
+  mkdir -p "$CACHE_DIR"
+
+  if [ "$METHOD" = standalone ]; then
+    install_standalone
+    return
+  fi
+
+  case "$(distro)" in
+  macos)
+    install_macos
+    ;;
+  ubuntu | debian | raspbian)
+    install_deb
+    ;;
+  centos | fedora | rhel | opensuse)
+    install_rpm
+    ;;
+  arch)
+    install_aur
+    ;;
+  *)
+    echoh "Unsupported package manager."
+    install_standalone
+    ;;
+  esac
+}
+
+parse_arg() {
+  case "$1" in
+  *=*)
+    # Remove everything after first equal sign.
+    opt="${1%%=*}"
+    # Remove everything before first equal sign.
+    optarg="${1#*=}"
+    if [ ! "$optarg" ] && [ ! "${OPTIONAL-}" ]; then
+      echoerr "$opt requires an argument"
+      echoerr "Run with --help to see usage."
+      exit 1
+    fi
+    echo "$optarg"
+    return
+    ;;
+  esac
+
+  case "${2-}" in
+  "" | -*)
+    if [ ! "${OPTIONAL-}" ]; then
+      echoerr "$1 requires an argument"
+      echoerr "Run with --help to see usage."
+      exit 1
+    fi
+    ;;
+  *)
+    echo "$2"
+    return
+    ;;
+  esac
+}
+
+fetch() {
+  URL="$1"
+  FILE="$2"
+
+  if [ -e "$FILE" ]; then
+    echoh "+ Reusing $CACHE_DIR/${URL##*/}"
+    return
+  fi
+
+  sh_c curl \
+    -#fL \
+    -o "$FILE.incomplete" \
+    -C - \
+    "$URL"
+  sh_c mv "$FILE.incomplete" "$FILE"
+}
+
+install_macos() {
+  if command_exists brew; then
+    echoh "Installing from Homebrew."
+    echoh
+
+    sh_c brew install code-server
+
+    return
+  fi
+
+  echoh "Homebrew not installed."
+
+  install_standalone
+}
+
+install_deb() {
+  echoh "Installing v$VERSION deb package from GitHub releases."
+  echoh
+
+  fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server_${VERSION}_$ARCH.deb" \
+    "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb"
+  sudo_sh_c dpkg -i "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb"
+
+  echo_systemd_postinstall
+}
+
+install_rpm() {
+  echoh "Installing v$VERSION rpm package from GitHub releases."
+  echoh
+
+  fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-$ARCH.rpm" \
+    "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm"
+  sudo_sh_c rpm -i "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm"
+
+  echo_systemd_postinstall
+}
+
+install_aur() {
+  echoh "Installing from the AUR."
+  echoh
+
+  sh_c mkdir -p "$CACHE_DIR/code-server-aur"
+  sh_c "curl -#fsSL https://aur.archlinux.org/cgit/aur.git/snapshot/code-server.tar.gz | tar -xzC $CACHE_DIR/code-server-aur --strip-components 1"
+  echo "+ cd $CACHE_DIR/code-server-aur"
+  if [ ! "${DRY_RUN-}" ]; then
+    cd "$CACHE_DIR/code-server-aur"
+  fi
+  sh_c makepkg -si
+
+  echo_systemd_postinstall
+}
+
+install_standalone() {
+  echoh "Installing standalone release archive v$VERSION"
+  echoh
+
+  fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-$OS-$ARCH.tar.gz" \
+    "$CACHE_DIR/code-server-$VERSION-$OS-$ARCH.tar.gz"
+
+  sh_c="sh_c"
+  if [ ! -w "$STANDALONE_INSTALL_PREFIX" ]; then
+    sh_c="sudo_sh_c"
+  fi
+
+  if [ -e "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION" ]; then
+    echoh
+    echoh "code-server-$VERSION is already installed at $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION"
+    echoh "Remove it to reinstall."
+    exit 0
+  fi
+
+  "$sh_c" mkdir -p "$STANDALONE_INSTALL_PREFIX/lib" "$STANDALONE_INSTALL_PREFIX/bin"
+  "$sh_c" tar -C "$STANDALONE_INSTALL_PREFIX/lib" -xzf "$CACHE_DIR/code-server-$VERSION-$OS-$ARCH.tar.gz"
+  "$sh_c" mv -f "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION-$OS-$ARCH" "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION"
+  "$sh_c" ln -fs "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION/bin/code-server" "$STANDALONE_INSTALL_PREFIX/bin/code-server"
+
+  echo_standalone_postinstall
+}
+
+install_npm() {
+  if command_exists yarn; then
+    sh_c="sh_c"
+    if [ ! -w "$(yarn global bin)" ]; then
+      sh_c="sudo_sh_c"
+    fi
+    echoh "Installing with yarn."
+    echoh
+    "$sh_c" yarn global add code-server --unsafe-perm
+    return
+  elif command_exists npm; then
+    sh_c="sh_c"
+    if [ ! -w "$(npm config get prefix)" ]; then
+      sh_c="sudo_sh_c"
+    fi
+    echoh "Installing with npm."
+    echoh
+    "$sh_c" npm install -g code-server --unsafe-perm
+    return
+  fi
+  echoh
+  echoerr "Please install npm or yarn to install code-server!"
+  echoerr "You will need at least node v12 and a few C dependencies."
+  echoerr "See the docs https://github.com/cdr/code-server#yarn-npm"
+  exit 1
+}
+
+os() {
+  case "$(uname)" in
+  Linux)
+    echo linux
+    ;;
+  Darwin)
+    echo macos
+    ;;
+  esac
+}
+
+# distro prints the detected operating system including linux distros.
+#
+# Example outputs:
+# - macos
+# - debian, ubuntu, raspbian
+# - centos, fedora, rhel, opensuse
+# - alpine
+# - arch
+#
+# Inspired by https://github.com/docker/docker-install/blob/26ff363bcf3b3f5a00498ac43694bf1c7d9ce16c/install.sh#L111-L120.
+distro() {
+  if [ "$(uname)" = "Darwin" ]; then
+    echo "macos"
+    return
+  fi
+
+  if [ -f /etc/os-release ]; then
+    (
+      . /etc/os-release
+      case "$ID" in opensuse-*)
+        # opensuse's ID's look like opensuse-leap and opensuse-tumbleweed.
+        echo "opensuse"
+        return
+        ;;
+      esac
+
+      echo "$ID"
+    )
+    return
+  fi
+}
+
+# os_name prints a pretty human readable name for the OS/Distro.
+distro_name() {
+  if [ "$(uname)" = "Darwin" ]; then
+    echo "macOS v$(sw_vers -productVersion)"
+    return
+  fi
+
+  if [ -f /etc/os-release ]; then
+    (
+      . /etc/os-release
+      echo "$PRETTY_NAME"
+    )
+    return
+  fi
+
+  # Prints something like: Linux 4.19.0-9-amd64
+  uname -sr
+}
+
+arch() {
+  case "$(uname -m)" in
+  aarch64)
+    echo arm64
+    ;;
+  x86_64)
+    echo amd64
+    ;;
+  esac
+}
+
+command_exists() {
+  command -v "$@" > /dev/null 2>&1
+}
+
+sh_c() {
+  echoh "+ $*"
+  if [ ! "${DRY_RUN-}" ]; then
+    sh -c "$*"
+  fi
+}
+
+sudo_sh_c() {
+  if [ "$(id -u)" = 0 ]; then
+    sh_c "$@"
+  elif command_exists sudo; then
+    sh_c "sudo $*"
+  elif command_exists su; then
+    sh_c "su -c '$*'"
+  else
+    echoh
+    echoerr "This script needs to run the following command as root."
+    echoerr "  $*"
+    echoerr "Please install sudo or su."
+    exit 1
+  fi
+}
+
+echo_cache_dir() {
+  if [ "${XDG_CACHE_HOME-}" ]; then
+    echo "$XDG_CACHE_HOME/code-server"
+  elif [ "${HOME-}" ]; then
+    echo "$HOME/.cache/code-server"
+  else
+    echo "/tmp/code-server-cache"
+  fi
+}
+
+echoh() {
+  echo "$@" | humanpath
+}
+
+cath() {
+  humanpath
+}
+
+echoerr() {
+  echoh "$@" >&2
+}
+
+# humanpath replaces all occurances of " $HOME" with " ~"
+# and all occurances of '"$HOME' with the literal '"$HOME'.
+humanpath() {
+  sed "s# $HOME# ~#g; s#\"$HOME#\"\$HOME#g"
+}
+
+main "$@"

package.json

@@ -1,7 +1,7 @@
 {
   "name": "code-server",
   "license": "MIT",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "Run VS Code on a remote server.",
   "homepage": "https://github.com/cdr/code-server",
   "bugs": {
@@ -16,10 +16,10 @@
     "build": "./ci/build/build-code-server.sh",
     "build:vscode": "./ci/build/build-vscode.sh",
     "release": "./ci/build/build-release.sh",
-    "release:static": "./ci/build/build-static-release.sh",
+    "release:standalone": "./ci/build/build-standalone-release.sh",
     "release:github-draft": "./ci/build/release-github-draft.sh",
     "release:github-assets": "./ci/build/release-github-assets.sh",
-    "test:static-release": "./ci/build/test-static-release.sh",
+    "test:standalone-release": "./ci/build/test-standalone-release.sh",
     "package": "./ci/build/build-packages.sh",
     "_____": "",
     "fmt": "./ci/dev/fmt.sh",