Merge pull request #1701 from cdr/auto-install

Add auto install script

Author: nhooyr

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Report a bug and help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+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
-  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.
+![Screenshot](./doc/assets/screenshot.png)
 
-![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
-
-```bash
-curl -sSOL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server_3.3.1_amd64.deb
-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
-
-```bash
-curl -sSOL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-amd64.rpm
-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
-
-```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` if we don't have a precompiled release for your machine's
-platform or architecture or your glibc < v2.19.
+We have a [script](./install.sh) to install code-server for Linux and macOS.
 
-**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.
+It tries to use the system package manager if possible.
 
-You will need at least node v12 installed. See [#1633](https://github.com/cdr/code-server/issues/1633).
+First run to print out the install process:
 
 ```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
+curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
 ```
 
-### macOS
+Now to actually install:
 
 ```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
+curl -fsSL https://code-server.dev/install.sh | sh
 ```
 
-### 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
-```
+The install script will print out how to run and start using code-server.
 
-### Static Releases
+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.
 
-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
-```
+Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
 
 ## 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.
-- [./ci/build/test-static-release.sh](./build/test-static-release.sh) (`yarn test:static-release`)
-  - Ensures code-server in the `./release-static` directory works by installing an extension.
+  - Copied into standalone releases to run code-server with the bundled node binary.
+- [./ci/build/test-standalone-release.sh](./build/test-standalone-release.sh) (`yarn test:standalone-release`)
+  - 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)
-  - Takes the output of the previous script and generates a static release and
-    release packages into `release-packages`.
+- [./steps/release-packages.sh](./steps/release-packages.sh)
+  - Takes the output of the previous script and generates a standalone release and
+    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,15 +9,15 @@ 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
     sed -i.bak "1s;^;#!/usr/bin/env node\n;" out/node/entry.js && rm out/node/entry.js.bak
     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,23 +11,27 @@ main() {
   mkdir -p release-packages
 
   release_archive
-  if [[ $OS == linux && $ARCH == "amd64" ]]; then
-    # Will stop most of the auto update issues.
-    # For the other releases it's more important to not pollute the release listing.
-    ARCH=x86_64 release_archive
+  # Will stop the auto update issues and allow people to upgrade their scripts
+  # for the new release structure.
+  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
 }
 
 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-static-release.sh renamed to ci/build/build-standalone-release.sh

@@ -5,8 +5,8 @@ main() {
   cd "$(dirname "${0}")/../.."
   source ./ci/lib.sh
 
-  rsync "$RELEASE_PATH/" "$RELEASE_PATH-static"
-  RELEASE_PATH+=-static
+  rsync "$RELEASE_PATH/" "$RELEASE_PATH-standalone"
+  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 "$@"