From f06a7cca524f1a0f4c9411db2d31fff343cbc21c Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 28 Apr 2021 13:40:45 -0700 Subject: [PATCH 1/3] docs: add termux.md --- ci/dev/fmt.sh | 1 + docs/termux.md | 1 + 2 files changed, 2 insertions(+) create mode 100644 docs/termux.md diff --git a/ci/dev/fmt.sh b/ci/dev/fmt.sh index 4f8953579..f72c5e92e 100755 --- a/ci/dev/fmt.sh +++ b/ci/dev/fmt.sh @@ -30,6 +30,7 @@ main() { doctoc --title '# Maintaining' docs/MAINTAINING.md >/dev/null doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null doctoc --title '# iPad' docs/ipad.md >/dev/null + doctoc --title '# Termux' docs/ipad.md >/dev/null if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then echo "Files need generation or are formatted incorrectly:" diff --git a/docs/termux.md b/docs/termux.md new file mode 100644 index 000000000..fbf469914 --- /dev/null +++ b/docs/termux.md @@ -0,0 +1 @@ +# Termux \ No newline at end of file From 4e34eb96c80e81441270fea4a6342ad6b608b94f Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 28 Apr 2021 13:44:07 -0700 Subject: [PATCH 2/3] refactor(docs): move termux info install -> termux --- ci/dev/fmt.sh | 2 +- docs/install.md | 28 +--------------------------- docs/termux.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 48 insertions(+), 29 deletions(-) diff --git a/ci/dev/fmt.sh b/ci/dev/fmt.sh index f72c5e92e..849440fee 100755 --- a/ci/dev/fmt.sh +++ b/ci/dev/fmt.sh @@ -30,7 +30,7 @@ main() { doctoc --title '# Maintaining' docs/MAINTAINING.md >/dev/null doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null doctoc --title '# iPad' docs/ipad.md >/dev/null - doctoc --title '# Termux' docs/ipad.md >/dev/null + doctoc --title '# Termux' docs/termux.md >/dev/null if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then echo "Files need generation or are formatted incorrectly:" diff --git a/docs/install.md b/docs/install.md index 91e0ebcb2..f9e77616c 100644 --- a/docs/install.md +++ b/docs/install.md @@ -10,7 +10,6 @@ - [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse) - [Arch Linux](#arch-linux) - [Termux](#termux) - - [Known Search Issue](#known-search-issue) - [yarn, npm](#yarn-npm) - [macOS](#macos) - [Standalone Releases](#standalone-releases) @@ -131,32 +130,7 @@ sudo systemctl enable --now code-server@$USER ## Termux -Termux is an Android terminal application and Linux environment, which can also run code-server from your phone. - -1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_US&gl=US) -2. Make sure it's up-to-date by running `apt update && apt upgrade` -3. Install required packages: `apt install build-essential python git nodejs yarn` -4. Install code-server: `yarn global add code-server` -5. Run code-server: `code-server` and navigate to localhost:8080 in your browser - -To upgrade run: `yarn global upgrade code-server --latest` - -### Known Search Issue - -There is a known issue with search not working on Android because it's missing `bin/rg`. To fix: - -1. Install `ripgrep` with `pkg` - ```sh - pkg install ripgrep - ``` -2. Make a soft link using `ln -s` - -```sh -# run this command inside the code-server directory -ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg -``` - -For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979). +Please see "Installation" in the [Termux docs](./termux.md#installation) ## yarn, npm diff --git a/docs/termux.md b/docs/termux.md index fbf469914..6970b358c 100644 --- a/docs/termux.md +++ b/docs/termux.md @@ -1 +1,46 @@ -# Termux \ No newline at end of file + + +# Termux + +- [Termux](#termux) + - [Installation](#installation) + - [Upgrading](#upgrading) + - [Known Issues](#known-issues) + - [Search issue](#search-issue) + + + +# Termux + +Termux is an Android terminal application and Linux environment, which can also run code-server from your phone. + +## Installation + +1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_US&gl=US) +2. Make sure it's up-to-date by running `apt update && apt upgrade` +3. Install required packages: `apt install build-essential python git nodejs yarn` +4. Install code-server: `yarn global add code-server` +5. Run code-server: `code-server` and navigate to localhost:8080 in your browser + +## Upgrading + +To upgrade run: `yarn global upgrade code-server --latest` + +## Known Issues + +### Search issue + +There is a known issue with search not working on Android because it's missing `bin/rg`. To fix: + +1. Install `ripgrep` with `pkg` + ```sh + pkg install ripgrep + ``` +2. Make a soft link using `ln -s` + +```sh +# run this command inside the code-server directory +ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg +``` + +For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979). From c16845b7bc8774c20d66999531773fbcfca2df81 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 28 Apr 2021 13:49:38 -0700 Subject: [PATCH 3/3] docs: add backspace issue to termux.md --- docs/termux.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/termux.md b/docs/termux.md index 6970b358c..ff5f6ff81 100644 --- a/docs/termux.md +++ b/docs/termux.md @@ -7,6 +7,7 @@ - [Upgrading](#upgrading) - [Known Issues](#known-issues) - [Search issue](#search-issue) + - [Backspace not working](#backspace-not-working) @@ -16,7 +17,7 @@ Termux is an Android terminal application and Linux environment, which can also ## Installation -1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_US&gl=US) +1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux) 2. Make sure it's up-to-date by running `apt update && apt upgrade` 3. Install required packages: `apt install build-essential python git nodejs yarn` 4. Install code-server: `yarn global add code-server` @@ -44,3 +45,17 @@ ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg ``` For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979). + +### Backspace not working + +There is a known issue with the backspace key not working correctly when using the on-screen keyboard on Android. This is due to an upstream issue. Read more: + +- [Issues with Backspace in Codespaces on Android (Surface Duo)](https://github.com/microsoft/vscode/issues/107602) +- [Support mobile platforms](https://github.com/xtermjs/xterm.js/issues/1101) + +Workaround: use a Bluetooth keyboard. + +For more context, see issues: + +- [500 error: 3.9.2 not working on Android + Termux](https://github.com/cdr/code-server/issues/3036) +- [Document Android backspace issue](https://github.com/cdr/code-server/issues/3079)