|
| 1 | +# Teldrive on Android (Termux) |
| 2 | + |
| 3 | +## Prerequisites |
| 4 | + |
| 5 | +Setting up Teldrive on Android, ensure you have the following in place. |
| 6 | + |
| 7 | +### Before you begin |
| 8 | + |
| 9 | +- Read the main [Prerequisites guide.](docs/getting-started/prerequisites). |
| 10 | +- An installed Termux. |
| 11 | + |
| 12 | +## Database and Telegram setup |
| 13 | + |
| 14 | +This guide only covers Supabase (cloud-hosted) and does not include local database setup. |
| 15 | + |
| 16 | +### Getting Telegram `api_id` and `api_hash` |
| 17 | + |
| 18 | +Follow these steps to obtain your Telegram API credentials. |
| 19 | + |
| 20 | +1. Go to [Telegram Authorization](https://my.telegram.org/auth). |
| 21 | + |
| 22 | +2. **Log in to the Developer Portal** |
| 23 | + Access the **Telegram My Apps** page. |
| 24 | + |
| 25 | +3. **Verify Your Account** |
| 26 | + - Enter your phone number in international format (e.g., `+1234567890`). |
| 27 | + - A confirmation code will be sent **via the Telegram app** (not SMS). |
| 28 | + - Enter the code to sign in. |
| 29 | + |
| 30 | +4. **Access API Tools** |
| 31 | + Select **API development tools** from the menu. |
| 32 | + |
| 33 | +5. **Create a New Application** |
| 34 | + - Fill out the **Create new application** form. |
| 35 | + - Required fields: |
| 36 | + - **App title** |
| 37 | + - **Short name** |
| 38 | + - Optional fields (such as **URL**) can be left blank or filled with placeholders. |
| 39 | + |
| 40 | +6. **Retrieve API Keys** |
| 41 | + After submission, your **`api_id`** and **`api_hash`** will be displayed. |
| 42 | + |
| 43 | +> [!Note] |
| 44 | +> - Copy both keys and store them securely. You will need them later. |
| 45 | +> - Once all prerequisites are ready, proceed to the installation section. |
| 46 | +
|
| 47 | +## Installation |
| 48 | + |
| 49 | +### Installing Termux |
| 50 | + |
| 51 | +Before continuing, ensure that Termux is installed correctly. |
| 52 | + |
| 53 | +### Download Sources |
| 54 | + |
| 55 | +Install Termux **only** from one of the following official sources: |
| 56 | + |
| 57 | +- **F-Droid:** https://f-droid.org/en/packages/com.termux/ |
| 58 | +- **GitHub Releases:** https://github.com/termux/termux-app/releases |
| 59 | + |
| 60 | +> [!Important] |
| 61 | +> - Do **not** install Termux from the Google Play Store. |
| 62 | +> - The Play Store version is outdated and no longer supported. |
| 63 | +
|
| 64 | +### Choosing the Correct APK |
| 65 | + |
| 66 | +When installing from GitHub releases, you may see multiple APK variants: |
| 67 | + |
| 68 | +- **`arm64-v8a`** — Recommended for most modern Android devices |
| 69 | +- **`armeabi-v7a`** — For older 32-bit ARM devices |
| 70 | +- **`universal.apk`** — Works on all devices |
| 71 | + |
| 72 | +> If you are **not sure** which architecture your device uses, install **`universal.apk`**, which works on all devices. |
| 73 | +
|
| 74 | +### Initial Termux Setup |
| 75 | + |
| 76 | +After opening Termux for the first time: |
| 77 | + |
| 78 | +1. Allow storage access when prompted. |
| 79 | + |
| 80 | +2. Run the following command in Termux: |
| 81 | + ```bash |
| 82 | + termux-setup-storage |
| 83 | + ``` |
| 84 | + |
| 85 | +3. Update and upgrade packages: |
| 86 | + ```bash |
| 87 | + pkg update && pkg upgrade |
| 88 | + ``` |
| 89 | +> Once completed, Termux is ready for use. |
| 90 | +
|
| 91 | +### Method: One-line installer |
| 92 | + |
| 93 | +- [Follow Here](docs/getting-started/installation) |
| 94 | + |
| 95 | +## Configuration |
| 96 | + |
| 97 | +- Read [this](docs/getting-started/usage#configuration) |
| 98 | + |
| 99 | +### Basic `config.toml` (Recommended for New Users) |
| 100 | + |
| 101 | +1. First, read the [usage documentation](docs/getting-started/usage) for configuring a Supabase database. |
| 102 | + |
| 103 | +2. Create and open the configuration file: |
| 104 | + |
| 105 | +```bash |
| 106 | +nano config.toml |
| 107 | +``` |
| 108 | + |
| 109 | +> [!NOTE] |
| 110 | +> - If the file does not exist, `nano` will create it automatically. |
| 111 | +> - View a complete sample configuration at the [GitHub repository](https://github.com/tgdrive/teldrive/blob/main/config.sample.toml) |
| 112 | +
|
| 113 | +### Saving and Exiting Nano |
| 114 | + |
| 115 | +- Press **Ctrl + O** to save |
| 116 | +- Press **Enter** to confirm |
| 117 | +- Press **Ctrl + X** to exit |
| 118 | + |
| 119 | +> To run Teldrive, follow the instructions here. [Running without Docker](docs/getting-started/usage#running-without-docker) |
| 120 | +
|
| 121 | +## Accessing Teldrive |
| 122 | + |
| 123 | +- Open http://localhost:8080 in your browser. |
| 124 | +> See the main guide: [Here](docs/getting-started/usage#accessing-teldrive) |
0 commit comments