|
| 1 | +<!-- START doctoc generated TOC please keep comment here to allow auto update --> |
| 2 | +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
| 3 | +# Termux |
| 4 | + |
| 5 | +- [Termux](#termux) |
| 6 | + - [Installation](#installation) |
| 7 | + - [Upgrading](#upgrading) |
| 8 | + - [Known Issues](#known-issues) |
| 9 | + - [Search issue](#search-issue) |
| 10 | + - [Backspace not working](#backspace-not-working) |
| 11 | + |
| 12 | +<!-- END doctoc generated TOC please keep comment here to allow auto update --> |
| 13 | + |
| 14 | +# Termux |
| 15 | + |
| 16 | +Termux is an Android terminal application and Linux environment, which can also run code-server from your phone. |
| 17 | + |
| 18 | +## Installation |
| 19 | + |
| 20 | +1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux) |
| 21 | +2. Make sure it's up-to-date by running `apt update && apt upgrade` |
| 22 | +3. Install required packages: `apt install build-essential python git nodejs yarn` |
| 23 | +4. Install code-server: `yarn global add code-server` |
| 24 | +5. Run code-server: `code-server` and navigate to localhost:8080 in your browser |
| 25 | + |
| 26 | +## Upgrading |
| 27 | + |
| 28 | +To upgrade run: `yarn global upgrade code-server --latest` |
| 29 | + |
| 30 | +## Known Issues |
| 31 | + |
| 32 | +### Search issue |
| 33 | + |
| 34 | +There is a known issue with search not working on Android because it's missing `bin/rg`. To fix: |
| 35 | + |
| 36 | +1. Install `ripgrep` with `pkg` |
| 37 | + ```sh |
| 38 | + pkg install ripgrep |
| 39 | + ``` |
| 40 | +2. Make a soft link using `ln -s` |
| 41 | + |
| 42 | +```sh |
| 43 | +# run this command inside the code-server directory |
| 44 | +ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg |
| 45 | +``` |
| 46 | + |
| 47 | +For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979). |
| 48 | + |
| 49 | +### Backspace not working |
| 50 | + |
| 51 | +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: |
| 52 | + |
| 53 | +- [Issues with Backspace in Codespaces on Android (Surface Duo)](https://github.com/microsoft/vscode/issues/107602) |
| 54 | +- [Support mobile platforms](https://github.com/xtermjs/xterm.js/issues/1101) |
| 55 | + |
| 56 | +Workaround: use a Bluetooth keyboard. |
| 57 | + |
| 58 | +For more context, see issues: |
| 59 | + |
| 60 | +- [500 error: 3.9.2 not working on Android + Termux](https://github.com/cdr/code-server/issues/3036) |
| 61 | +- [Document Android backspace issue](https://github.com/cdr/code-server/issues/3079) |
0 commit comments