code-server/install.sh

578 lines
13 KiB
Bash
Raw Normal View History

2020-05-20 16:50:16 +08:00
#!/bin/sh
set -eu
2020-05-23 03:38:03 +08:00
# code-server's automatic install script.
2021-03-05 06:24:59 +08:00
# See https://github.com/cdr/code-server/blob/v3.9.1/docs/install.md
2020-05-23 03:38:03 +08:00
2020-05-20 16:50:16 +08:00
usage() {
2020-05-23 03:38:03 +08:00
arg0="$0"
if [ "$0" = sh ]; then
2020-05-23 03:38:03 +08:00
arg0="curl -fsSL https://code-server.dev/install.sh | sh -s --"
else
2020-05-28 05:46:55 +08:00
not_curl_usage="The latest script is available at https://code-server.dev/install.sh
2020-05-23 03:38:03 +08:00
"
fi
2020-05-23 03:38:03 +08:00
cath <<EOF
2020-06-13 22:56:50 +08:00
Installs code-server for Linux, macOS and FreeBSD.
2020-05-22 10:16:16 +08:00
It tries to use the system package manager if possible.
After successful installation it explains how to start using code-server.
Pass in user@host to install code-server on user@host over ssh.
The remote host must have internet access.
2020-05-28 05:46:55 +08:00
${not_curl_usage-}
Usage:
2020-05-20 16:50:16 +08:00
$arg0 [--dry-run] [--version X.X.X] [--method detect] \
[--prefix ~/.local] [--rsh ssh] [user@host]
2020-05-23 03:38:03 +08:00
--dry-run
Echo the commands for the install process without running them.
2020-05-23 03:38:03 +08:00
--version X.X.X
Install a specific version instead of the latest.
2020-05-28 04:39:17 +08:00
--method [detect | standalone]
2020-05-23 03:38:03 +08:00
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.
2020-05-28 04:39:17 +08:00
- standalone installs a standalone release archive into ~/.local
2020-05-23 03:38:03 +08:00
Add ~/.local/bin to your \$PATH to use it.
2020-05-23 03:38:03 +08:00
--prefix <dir>
2020-05-28 04:39:17 +08:00
Sets the prefix used by standalone release archives. Defaults to ~/.local
2020-05-23 03:38:03 +08:00
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
2020-05-22 11:53:02 +08:00
--rsh <bin>
Specifies the remote shell for remote installation. Defaults to ssh.
2020-05-22 10:16:16 +08:00
- 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.
2020-05-28 04:39:17 +08:00
- For any unrecognized Linux operating system it will install the latest standalone
2020-05-22 10:16:16 +08:00
release into ~/.local
2020-05-20 16:50:16 +08:00
- For macOS it will install the Homebrew package.
2020-05-28 04:39:17 +08:00
- If Homebrew is not installed it will install the latest standalone release
2020-05-22 10:16:16 +08:00
into ~/.local
2020-05-20 16:50:16 +08:00
2020-06-13 22:56:50 +08:00
- For FreeBSD, it will install the npm package with yarn or npm.
2020-05-28 04:39:17 +08:00
- If ran on an architecture with no releases, it will install the
2020-05-22 10:16:16 +08:00
npm package with yarn or npm.
2020-05-28 04:39:17 +08:00
- We only have releases for amd64 and arm64 presently.
2020-05-28 04:48:11 +08:00
- The npm package builds the native modules on postinstall.
2020-05-20 16:50:16 +08:00
2020-05-23 03:38:03 +08:00
It will cache all downloaded assets into ~/.cache/code-server
2021-03-05 06:24:59 +08:00
More installation docs are at https://github.com/cdr/code-server/blob/v3.9.1/docs/install.md
2020-05-20 16:50:16 +08:00
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/}"
version="${version#v}"
echo "$version"
2020-05-20 16:50:16 +08:00
}
echo_npm_postinstall() {
echoh
cath <<EOF
The npm package has been installed successfully!
Please extend your path to use code-server:
PATH="$NPM_BIN_DIR:\$PATH"
Please run with:
code-server
EOF
}
2020-05-28 04:39:17 +08:00
echo_standalone_postinstall() {
2020-05-28 05:01:33 +08:00
echoh
cath <<EOF
2020-05-28 04:39:17 +08:00
Standalone release has been installed into $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION
2020-05-20 16:50:16 +08:00
Please extend your path to use code-server:
2020-05-28 04:39:17 +08:00
PATH="$STANDALONE_INSTALL_PREFIX/bin:\$PATH"
2020-05-20 16:50:16 +08:00
Then you can run:
code-server
EOF
}
echo_systemd_postinstall() {
2020-05-28 05:01:33 +08:00
echoh
cath <<EOF
2020-05-20 16:50:16 +08:00
To have systemd start code-server now and restart on boot:
sudo systemctl enable --now code-server@\$USER
2020-05-20 16:50:16 +08:00
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 \
2020-05-23 03:38:03 +08:00
METHOD \
2020-05-28 04:39:17 +08:00
STANDALONE_INSTALL_PREFIX \
VERSION \
OPTIONAL \
ALL_FLAGS \
RSH_ARGS \
RSH
ALL_FLAGS=""
while [ "$#" -gt 0 ]; do
case "$1" in
-*)
ALL_FLAGS="${ALL_FLAGS} $1"
;;
esac
case "$1" in
--dry-run)
DRY_RUN=1
;;
2020-05-23 03:38:03 +08:00
--method)
METHOD="$(parse_arg "$@")"
shift
;;
--method=*)
METHOD="$(parse_arg "$@")"
;;
2020-05-23 03:38:03 +08:00
--prefix)
2020-05-28 04:39:17 +08:00
STANDALONE_INSTALL_PREFIX="$(parse_arg "$@")"
2020-05-23 03:38:03 +08:00
shift
;;
--prefix=*)
2020-05-28 04:39:17 +08:00
STANDALONE_INSTALL_PREFIX="$(parse_arg "$@")"
;;
--version)
VERSION="$(parse_arg "$@")"
shift
;;
--version=*)
VERSION="$(parse_arg "$@")"
;;
--rsh)
RSH="$(parse_arg "$@")"
shift
;;
--rsh=*)
RSH="$(parse_arg "$@")"
;;
2020-05-23 03:38:03 +08:00
-h | --h | -help | --help)
usage
exit 0
;;
--)
shift
# We remove the -- added above.
ALL_FLAGS="${ALL_FLAGS% --}"
RSH_ARGS="$*"
break
;;
-*)
echoerr "Unknown flag $1"
echoerr "Run with --help to see usage."
exit 1
;;
*)
RSH_ARGS="$*"
break
;;
2020-05-20 16:50:16 +08:00
esac
shift
2020-05-20 16:50:16 +08:00
done
if [ "${RSH_ARGS-}" ]; then
2020-10-22 13:43:22 +08:00
RSH="${RSH-ssh}"
echoh "Installing remotely with $RSH $RSH_ARGS"
curl -fsSL https://code-server.dev/install.sh | prefix "$RSH_ARGS" "$RSH" "$RSH_ARGS" sh -s -- "$ALL_FLAGS"
return
fi
VERSION="${VERSION-$(echo_latest_version)}"
2020-05-23 03:38:03 +08:00
METHOD="${METHOD-detect}"
2020-05-28 04:39:17 +08:00
if [ "$METHOD" != detect ] && [ "$METHOD" != standalone ]; then
2020-05-23 03:38:03 +08:00
echoerr "Unknown install method \"$METHOD\""
echoerr "Run with --help to see usage."
exit 1
fi
2020-05-28 04:39:17 +08:00
STANDALONE_INSTALL_PREFIX="${STANDALONE_INSTALL_PREFIX-$HOME/.local}"
2020-05-20 16:50:16 +08:00
OS="$(os)"
if [ ! "$OS" ]; then
echoerr "Unsupported OS $(uname)."
2020-05-20 16:50:16 +08:00
exit 1
fi
distro_name
ARCH="$(arch)"
if [ ! "$ARCH" ]; then
2020-05-28 04:39:17 +08:00
if [ "$METHOD" = standalone ]; then
2020-06-13 22:56:50 +08:00
echoerr "No precompiled releases for $(uname -m)."
2020-05-28 04:39:17 +08:00
echoerr 'Please rerun without the "--method standalone" flag to install from npm.'
2020-05-20 16:50:16 +08:00
exit 1
fi
2020-05-28 05:01:33 +08:00
echoh "No precompiled releases for $(uname -m)."
2020-05-20 16:50:16 +08:00
install_npm
2020-05-22 11:53:02 +08:00
return
2020-05-20 16:50:16 +08:00
fi
2020-06-13 22:56:50 +08:00
if [ "$OS" = "freebsd" ]; then
if [ "$METHOD" = standalone ]; then
echoerr "No precompiled releases available for $OS."
echoerr 'Please rerun without the "--method standalone" flag to install from npm.'
exit 1
fi
echoh "No precompiled releases available for $OS."
install_npm
return
fi
CACHE_DIR="$(echo_cache_dir)"
2020-05-20 16:50:16 +08:00
2020-05-28 04:39:17 +08:00
if [ "$METHOD" = standalone ]; then
install_standalone
2020-05-20 16:50:16 +08:00
return
fi
case "$(distro)" in
macos)
install_macos
;;
debian)
2020-05-20 16:50:16 +08:00
install_deb
;;
fedora | opensuse)
2020-05-20 16:50:16 +08:00
install_rpm
;;
arch)
2020-05-23 03:38:03 +08:00
install_aur
2020-05-20 16:50:16 +08:00
;;
*)
2020-05-28 05:01:33 +08:00
echoh "Unsupported package manager."
2020-05-28 04:39:17 +08:00
install_standalone
2020-05-20 16:50:16 +08:00
;;
esac
}
parse_arg() {
case "$1" in
*=*)
2020-05-28 03:48:03 +08:00
# 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"
2020-05-20 16:50:16 +08:00
return
;;
esac
2020-05-20 16:50:16 +08:00
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
2020-05-20 16:50:16 +08:00
}
fetch() {
URL="$1"
FILE="$2"
if [ -e "$FILE" ]; then
echoh "+ Reusing $FILE"
2020-05-20 16:50:16 +08:00
return
fi
sh_c mkdir -p "$CACHE_DIR"
2020-05-20 16:50:16 +08:00
sh_c curl \
-#fL \
2020-05-23 03:38:03 +08:00
-o "$FILE.incomplete" \
2020-05-20 16:50:16 +08:00
-C - \
"$URL"
2020-05-23 03:38:03 +08:00
sh_c mv "$FILE.incomplete" "$FILE"
2020-05-20 16:50:16 +08:00
}
install_macos() {
if command_exists brew; then
2020-05-28 05:01:33 +08:00
echoh "Installing from Homebrew."
echoh
sh_c brew install code-server
return
fi
2020-05-28 05:01:33 +08:00
echoh "Homebrew not installed."
2020-05-28 04:39:17 +08:00
install_standalone
}
2020-05-20 16:50:16 +08:00
install_deb() {
2020-05-28 05:01:33 +08:00
echoh "Installing v$VERSION deb package from GitHub releases."
echoh
2020-05-20 16:50:16 +08:00
2020-05-27 11:15:44 +08:00
fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server_${VERSION}_$ARCH.deb" \
"$CACHE_DIR/code-server_${VERSION}_$ARCH.deb"
2020-05-20 16:50:16 +08:00
sudo_sh_c dpkg -i "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb"
echo_systemd_postinstall
}
install_rpm() {
2020-05-28 05:01:33 +08:00
echoh "Installing v$VERSION rpm package from GitHub releases."
echoh
2020-05-20 16:50:16 +08:00
2020-05-27 11:15:44 +08:00
fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-$ARCH.rpm" \
"$CACHE_DIR/code-server-$VERSION-$ARCH.rpm"
2020-05-20 16:50:16 +08:00
sudo_sh_c rpm -i "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm"
echo_systemd_postinstall
}
install_aur() {
2020-05-28 05:01:33 +08:00
echoh "Installing from the AUR."
echoh
2020-05-20 16:50:16 +08:00
2020-05-28 05:46:55 +08:00
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
2020-05-28 03:48:03 +08:00
sh_c makepkg -si
2020-05-20 16:50:16 +08:00
echo_systemd_postinstall
}
2020-05-28 04:39:17 +08:00
install_standalone() {
2020-05-28 08:38:29 +08:00
echoh "Installing standalone release archive v$VERSION from GitHub releases."
2020-05-28 05:01:33 +08:00
echoh
2020-05-20 16:50:16 +08:00
2020-05-23 03:38:03 +08:00
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"
2020-05-20 16:50:16 +08:00
sh_c="sh_c"
2020-05-28 04:39:17 +08:00
if [ ! -w "$STANDALONE_INSTALL_PREFIX" ]; then
2020-05-20 16:50:16 +08:00
sh_c="sudo_sh_c"
fi
2020-05-28 04:39:17 +08:00
if [ -e "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION" ]; then
2020-05-28 05:01:33 +08:00
echoh
echoh "code-server-$VERSION is already installed at $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION"
echoh "Remove it to reinstall."
2020-05-23 03:38:03 +08:00
exit 0
fi
2020-05-28 03:48:03 +08:00
2020-05-28 04:39:17 +08:00
"$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"
2020-05-20 16:50:16 +08:00
2020-05-28 04:39:17 +08:00
echo_standalone_postinstall
2020-05-20 16:50:16 +08:00
}
install_npm() {
if command_exists yarn; then
2020-05-28 03:48:03 +08:00
sh_c="sh_c"
if [ ! -w "$(yarn global bin)" ]; then
sh_c="sudo_sh_c"
fi
2020-05-28 05:01:33 +08:00
echoh "Installing with yarn."
echoh
2020-05-28 03:48:03 +08:00
"$sh_c" yarn global add code-server --unsafe-perm
NPM_BIN_DIR="$(yarn global bin)" echo_npm_postinstall
2020-05-20 16:50:16 +08:00
return
elif command_exists npm; then
2020-05-28 03:48:03 +08:00
sh_c="sh_c"
if [ ! -w "$(npm config get prefix)" ]; then
sh_c="sudo_sh_c"
fi
2020-05-28 05:01:33 +08:00
echoh "Installing with npm."
echoh
2020-05-28 03:48:03 +08:00
"$sh_c" npm install -g code-server --unsafe-perm
NPM_BIN_DIR="$(npm bin -g)" echo_npm_postinstall
2020-05-20 16:50:16 +08:00
return
fi
2020-05-28 05:01:33 +08:00
echoh
echoerr "Please install npm or yarn to install code-server!"
2020-05-23 03:38:03 +08:00
echoerr "You will need at least node v12 and a few C dependencies."
2021-03-05 06:24:59 +08:00
echoerr "See the docs https://github.com/cdr/code-server/blob/v3.9.1/docs/install.md#yarn-npm"
2020-05-20 16:50:16 +08:00
exit 1
}
os() {
case "$(uname)" in
Linux)
echo linux
;;
Darwin)
echo macos
;;
2020-06-13 22:56:50 +08:00
FreeBSD)
echo freebsd
;;
2020-05-20 16:50:16 +08:00
esac
}
# distro prints the detected operating system including linux distros.
# Also parses ID_LIKE for common distro bases.
2020-05-20 16:50:16 +08:00
#
# Example outputs:
# - macos -> macos
# - freebsd -> freebsd
# - ubuntu, raspbian, debian ... -> debian
# - amzn, centos, rhel, fedora, ... -> fedora
# - opensuse-{leap,tumbleweed} -> opensuse
# - alpine -> alpine
# - arch -> arch
2020-05-20 16:50:16 +08:00
#
# Inspired by https://github.com/docker/docker-install/blob/26ff363bcf3b3f5a00498ac43694bf1c7d9ce16c/install.sh#L111-L120.
distro() {
2020-06-13 22:56:50 +08:00
if [ "$OS" = "macos" ] || [ "$OS" = "freebsd" ]; then
echo "$OS"
2020-05-20 16:50:16 +08:00
return
fi
if [ -f /etc/os-release ]; then
(
. /etc/os-release
if [ "${ID_LIKE-}" ]; then
for id_like in $ID_LIKE; do
case "$id_like" in debian | fedora | opensuse)
echo "$id_like"
return
;;
esac
done
fi
echo "$ID"
)
2020-05-20 16:50:16 +08:00
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
2020-05-20 16:50:16 +08:00
(
. /etc/os-release
echo "$PRETTY_NAME"
)
return
2020-05-20 16:50:16 +08:00
fi
# Prints something like: Linux 4.19.0-9-amd64
uname -sr
}
arch() {
case "$(uname -m)" in
aarch64)
echo arm64
;;
x86_64)
echo amd64
;;
2020-06-13 22:56:50 +08:00
amd64) # FreeBSD.
echo amd64
;;
2020-05-20 16:50:16 +08:00
esac
}
command_exists() {
command -v "$@" >/dev/null
2020-05-20 16:50:16 +08:00
}
sh_c() {
2020-05-28 05:01:33 +08:00
echoh "+ $*"
2020-05-20 16:50:16 +08:00
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 '$*'"
2020-05-20 16:50:16 +08:00
else
2020-05-28 05:01:33 +08:00
echoh
echoerr "This script needs to run the following command as root."
echoerr " $*"
2020-05-23 03:38:03 +08:00
echoerr "Please install sudo or su."
2020-05-20 16:50:16 +08:00
exit 1
fi
}
echo_cache_dir() {
2020-05-20 16:50:16 +08:00
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
}
2020-05-28 05:01:33 +08:00
echoh() {
echo "$@" | humanpath
2020-05-28 03:48:03 +08:00
}
2020-05-28 05:01:33 +08:00
cath() {
2020-05-28 03:48:03 +08:00
humanpath
}
echoerr() {
2020-05-28 05:01:33 +08:00
echoh "$@" >&2
}
2020-05-28 05:46:55 +08:00
# humanpath replaces all occurances of " $HOME" with " ~"
# and all occurances of '"$HOME' with the literal '"$HOME'.
2020-05-28 03:48:03 +08:00
humanpath() {
2020-05-28 05:46:55 +08:00
sed "s# $HOME# ~#g; s#\"$HOME#\"\$HOME#g"
2020-05-28 03:48:03 +08:00
}
# We need to make sure we exit with a non zero exit if the command fails.
# /bin/sh does not support -o pipefail unfortunately.
prefix() {
PREFIX="$1"
shift
fifo="$(mktemp -d)/fifo"
mkfifo "$fifo"
sed -e "s#^#$PREFIX: #" "$fifo" &
"$@" >"$fifo" 2>&1
}
2020-05-20 16:50:16 +08:00
main "$@"