diff --git a/docs/termux.md b/docs/termux.md index db50adf3c..8a9b7a870 100644 --- a/docs/termux.md +++ b/docs/termux.md @@ -5,67 +5,144 @@ - [Install](#install) - [Upgrade](#upgrade) - [Known Issues](#known-issues) - - [Search doesn't work](#search-doesnt-work) - - [Backspace doesn't work](#backspace-doesnt-work) + - [Git won't work in `/sdcard`](#git-wont-work-in-sdcard) +- [Extra](#extra) + - [Create a new user](#create-a-new-user) + - [Install Go](#install-go) + - [Install Python](#install-python) -Termux is a terminal application and Linux environment that you can also use to -run code-server from your Android phone. - ## Install -1. Install Termux from [F-Droid](https://f-droid.org/en/packages/com.termux/). -1. Make sure it's up-to-date: `apt update && apt upgrade` -1. Install required packages: `apt install build-essential python git nodejs-lts yarn` -1. Install code-server: `yarn global add code-server` -1. Run code-server: `code-server` and navigate to localhost:8080 in your browser +1. Get [Termux](https://f-droid.org/en/packages/com.termux/) from **F-Droid**. +2. Install Debian by running the following. + - Run `termux-setup-storage` to allow storage access, or else code-server won't be able to read from `/sdcard`.\ + If you used the Andronix command then you may have to edit the `start-debian.sh` script to mount `/sdcard` just as simple as uncommenting the `command+=" -b /sdcard"` line. + > The following command was extracted from [Andronix](https://andronix.app/) you can also use [proot-distro](https://github.com/termux/proot-distro). + > After Debian is installed the `~ $` will change to `root@localhost`. + +```bash +pkg update -y && pkg install wget curl proot tar -y && wget https://raw.githubusercontent.com/AndronixApp/AndronixOrigin/master/Installer/Debian/debian.sh -O debian.sh && chmod +x debian.sh && bash debian.sh +``` + +3. Run the following commands to setup Debian. + +```bash +apt update +apt upgrade -y +apt-get install nano vim sudo curl wget git -y +``` + +4. Install [NVM](https://github.com/nvm-sh/nvm) by following the install guide in the README, just a curl/wget command. +5. Set up NVM for multi-user. After installing NVM it automatically adds the necessary commands for it to work, but it will only work if you are logged in as root; + + - Copy the lines NVM asks you to run after running the install script. + - Run `nano /root/.bashrc` and comment out those lines by adding a `#` at the start. + - Run `nano /etc/profile` and paste those lines at the end and make sure to replace `$HOME` with `/root` + - Now run `exit` and start Debain again. + +6. After following the instructions and setting up NVM you can now install the [required node version](https://coder.com/docs/code-server/latest/npm#nodejs-version) using `nvm install version_here`. +7. To install `code-server` run the following. + > To check the install process (Will not actually install code-server) + > If it all looks good, you can install code-server by running the second command + +```bash +curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run +``` + +```bash +curl -fsSL https://code-server.dev/install.sh | sh +``` + +8. You can now start code server by simply running `code-server`. + +> Consider using a new user instead of root, read [here](https://www.howtogeek.com/124950/htg-explains-why-you-shouldnt-log-into-your-linux-system-as-root/) why using root is not recommended.\ +> Learn how to add a user [here](#create-a-new-user). ## Upgrade -To upgrade run: `yarn global upgrade code-server --latest` +1. Remove all previous installs `rm -rf ~/.local/lib/code-server-*` +2. Run the install script again `curl -fsSL https://code-server.dev/install.sh | sh` ## Known Issues -The following details known issues and suggested workarounds for using -code-server with Termux. +### Git won't work in `/sdcard` -### Search doesn't work +Issue : Using git in the `/sdcard` directory will fail during cloning/commit/staging/etc...\ +Fix : None\ +Potential Workaround : -There is a known issue with search not working on Android because it's missing -`bin/rg` ([context](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979)). To fix this: +1. Create a soft-link from the debian-fs to your folder in `/sdcard` +2. Use git from termux (preferred) -1. Install `ripgrep` with `pkg` +## Extra - ```sh - pkg install ripgrep - ``` +### Create a new user -1. Make a soft link using `ln -s` +To create a new user follow these simple steps - - ```sh - # run this command inside the code-server directory - ln -s $PREFIX/bin/rg ./vendor/modules/code-oss-dev/vscode-ripgrep/bin/rg - ``` +1. Create a new user by running `useradd username -m`. +2. Change the password by running `passwd username`. +3. Give your new user sudo access by runnning `visudo`, scroll down to `User privilege specification` and add the following line after root `username ALL=(ALL:ALL) ALL`. +4. Now edit the `/etc/passwd` file with your commadline editor of choice and at the end of the line that specifies your user change `/bin/sh` to `/bin/bash`. +5. Now switch users, by running `su - username` -### Backspace doesn't work +- Remember the `-` betweeen `su` and username is required to execute `/etc/profile`,\ + since `/etc/profile` may have some necessary things to be executed you should always add a `-`. -When using Android's on-screen keyboard, the backspace key doesn't work -properly. This is a known upstream issue: +### Install Go -- [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) +> From https://golang.org/doc/install -There are two workarounds. +1. Go to https://golang.org/dl/ and copy the download link for `linux arm` and run the following. -**Option 1:** Modify keyboard dispatch settings +```bash +wget download_link +``` -1. Open the Command Palette -2. Search for **Preferences: Open Settings (JSON)** -3. Add `"keyboard.dispatch": "keyCode"` +2. Extract the downloaded archive. (This step will erase all previous GO installs, make sure to create a backup if you have previously installed GO) -The backspace button should work at this point. +```bash +rm -rf /usr/local/go && tar -C /usr/local -xzf archive_name +``` -_Thanks to @Nefomemes for the [suggestion](https://github.com/cdr/code-server/issues/1141#issuecomment-789463707)!_ +3. Run `nano /etc/profile` and add the following line `export PATH=$PATH:/usr/local/go/bin`. +4. Now run `exit` (depending on if you have switched users or not, you may have to run `exit` multiple times to get to normal termux shell) and start Debian again. +5. Check if your install was successful by running `go version` -**Option 2:** Use a Bluetooth keyboard. +### Install Python + +> Run these commands as root + +1. Run the following command to install required packages to build python. + +```bash +sudo apt-get update +sudo apt-get install make build-essential libssl-dev zlib1g-dev \ + libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \ + libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev +``` + +2. Install [pyenv](https://github.com/pyenv/pyenv/) from [pyenv-installer](https://github.com/pyenv/pyenv-installer) by running. + +```bash +curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash +``` + +3. Run `nano /etc/profile` and add the following + +```bash +export PYENV_ROOT="/root/.pyenv" +export PATH="/root/.pyenv/bin:$PATH" +eval "$(pyenv init --path)" +eval "$(pyenv virtualenv-init -)" +``` + +4. Exit start Debian again. +5. Run `pyenv versions` to list all installable versions. +6. Run `pyenv install version` to install the desired python version. + > The build process may take some time (an hour or 2 depending on your device). +7. Run `touch /root/.pyenv/version && echo "your_version_here" > /root/.pyenv/version` +8. (You may have to start Debian again) Run `python3 -V` to verify if PATH works or not. + > If `python3` doesn't work but pyenv says that the install was successful in step 6 then try running `$PYENV_ROOT/versions/your_version/bin/python3`.