koreader-tailscale

KO | EN

gitlite — search

#javascript #react #typescript #golang #go #rust #linux #docker #macos #nodejs #windows #vue #openai #open-source

koreader-tailscale

(★ 166)

A koreader plugin for Tailscale VPN to get around the pesky local network requirements of many sync tools and services.

koreader-tailscale Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Tailscale Plugin for KOReader

Run Tailscale on your e-reader. Tested on Kindle PW5/PW6, Kobo, and PocketBook. Should work on any KOReader device with ARMv7 or ARM64.

Pairs well with [koreader-syncthing](https://github.com/jasonchoimtt/koreader-syncthing) for file sync over your tailnet.

## Prerequisites

1. **Tailscale Account**: Sign up at [tailscale.com](https://tailscale.com).
2. **Auth Key**: Create a reusable auth key at [Tailscale Admin Console](https://login.tailscale.com/admin/settings/keys).
3. **E-reader with file and/or SSH access**: With KOReader installed. Tested on Kindle PW6 and PW5, and PocketBook devices. Should work on any device running ARMv7 or ARM64 binaries.

## Installation

1. Copy `tailscale.koplugin` to your KOReader plugins directory:
   - **Kindle**: `/mnt/us/koreader/plugins/`
   - **Kobo**: `/mnt/onboard/.adds/koreader/plugins/`
   - **PocketBook**: `/mnt/ext1/koreader/plugins/`
2. Restart KOReader.
3. In KOReader: Menu → Plugins → Tailscale VPN → Install/Update Tailscale.

**Note**: Installation downloads ~57 MB. You can pre-download binaries and transfer via SCP/SSH to the plugin's `bin/` directory (default location depends on device).

## Setup

1. **Configure Auth Key**:
   Copy the auth.key file to the Tailscale `bin/` directory. Default locations:
   - **Kindle**: `/mnt/us/koreader/plugins/tailscale.koplugin/bin/auth.key`
   - **Kobo**: `/mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin/auth.key`
   - **PocketBook**: `/mnt/ext1/tailscale/bin/auth.key` (external storage)
   ```sh
   # Kindle default
   scp -P 2222 auth.key user@kindle-ip:/mnt/us/koreader/plugins/tailscale.koplugin/bin/auth.key
   # Kobo plugin directory (typical location)
   scp -P 2222 auth.key user@kobo-ip:/mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin/auth.key
   # PocketBook external storage
   scp -P 2222 auth.key user@pocketbook-ip:/mnt/ext1/tailscale/bin/auth.key
   ```

2. **(Optional) Use a self-hosted Headscale server**:
   If you run Headscale and want your device to use it instead of tailscale.com, create a file `headscale.url` in the Tailscale `bin/` directory. Default locations:
   - **Kindle**: `/mnt/us/koreader/plugins/tailscale.koplugin/bin/headscale.url`
   - **Kobo**: `/mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin/headscale.url`
   - **PocketBook**: `/mnt/ext1/tailscale/bin/headscale.url` (external storage)
   The plugin exposes a menu item *Headscale URL info* which shows the currently configured URL and instructions for updating it.

3. Menu → Network → Tailscale VPN → toggle **On**.

## Proxy

The plugin runs SOCKS5 on `127.0.0.1:1055` and HTTP CONNECT on `127.0.0.1:1056` so KOReader can reach tailnet services (OPDS, sync, etc.).

### Chmod Note

To make the scripts executable on the device, navigate to the Tailscale `bin/` directory and run `chmod +x`:

```sh
# Default Kindle location
cd /mnt/us/koreader/plugins/tailscale.koplugin/bin
chmod +x start_tailscale.sh

# Kobo plugin directory (typical location)
cd /mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin
chmod +x start_tailscale.sh

# PocketBook plugin directory
cd /mnt/ext1/koreader/plugins/tailscale.koplugin/bin
chmod +x start_tailscale.sh
```

## Installation Location

Tailscale binaries are installed in the plugin's `bin/` directory for Kindle and Kobo devices. For PocketBook devices, binaries are installed in external storage (`/mnt/ext1/tailscale/bin`) to avoid read-only filesystem limitations.

### Troubleshooting Space Issues

If installation fails due to insufficient space:

1. **Check available space** on the partition containing KOReader:
   ```bash
   df -h /mnt/us /mnt/onboard /mnt
   ```

2. Ensure at least 100MB free space is available.

3. If space is limited, consider moving KOReader to a different partition or using manual installation (see Manual Installation section).

## Usage with Syncthing

1. Note your Kindle's Tailscale IP from the status menu.
2. Install Tailscale and Syncthing on other devices.
3. Configure Syncthing to use the Tailscale IP by adding the address:
   ```
   tcp://<tailscale-ip or magic dns>:22000
   ```
4. Enjoy secure, remote file synchronization without having to be on the same network.

## Plugin Menu Commands

- **Tailscale VPN**: Toggle connection.
- **Status**: Show device IP and info.
- **Install/Update Tailscale**: Download and install binaries.
- **Uninstall Tailscale**: Stop and remove Tailscale files (removes auth key).

## Files Location

Files are located in the Tailscale `bin/` directory, which depends on the device:

- **Kindle**: `/mnt/us/koreader/plugins/tailscale.koplugin/bin/`
- **Kobo**: `/mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin/`
- **PocketBook**: `/mnt/ext1/tailscale/bin/` (external storage)

Logs (`tailscale.log`, `tailscaled.log`) and configuration files (`auth.key`, `headscale.url`) are stored in the same directory.

## Uninstall / Reinstall

1. **Uninstall**: Menu → Plugins → Tailscale VPN → Uninstall Tailscale.
2. **Reinstall**: Menu → Plugins → Tailscale VPN → Install/Update Tailscale.

You may want to backup your auth.key file (located in the plugin's `bin/` directory) by moving it to `auth.key.backup` or similar before uninstalling, and restore its name after reinstalling.

## Manual Installation

If the automatic installation fails, you can install Tailscale manually:

**Note**: Binaries are installed in the plugin's `bin/` directory. Replace `/mnt/us/koreader/plugins/tailscale.koplugin/bin/` with your actual plugin path if different.

**Migration**: If you previously used an external directory (e.g., `/mnt/us/tailscale`), move your existing binaries to the plugin's `bin/` directory.

### 1. Download Tailscale Binaries

Download the appropriate binaries for your device architecture (ARMv7/ARMv8/ARM64):

```bash
# On your computer
wget https://pkgs.tailscale.com/stable/tailscale_1.94.2_arm.tgz
# or
curl -O https://pkgs.tailscale.com/stable/tailscale_1.94.2_arm.tgz
```

### 2. Transfer to Your Device

Copy the archive to your e-reader:

```bash
# For Kindle (SSH on port 2222)
scp -P 2222 tailscale_1.94.2_arm.tgz root@<device-ip>:/mnt/us/koreader/plugins/tailscale.koplugin/bin/

# For Kobo (plugin directory)
scp tailscale_1.94.2_arm.tgz root@<device-ip>:/mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin/
```

### 3. Extract and Install

SSH into your device and run:

```bash
# Navigate to the bin directory
cd /mnt/us/koreader/plugins/tailscale.koplugin/bin  # or /mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin for Kobo

# Extract
tar xzf tailscale_1.94.2_arm.tgz

# Move binaries
mv tailscale_*/tailscale tailscale_*/tailscaled ./
rm -rf tailscale_* tailscale_1.94.2_arm.tgz

# Make executable
chmod +x tailscale tailscaled

# Create empty auth.key file if it doesn't exist
touch auth.key
```

### 4. Configure Auth Key

Create `auth.key` with your Tailscale auth key:

```bash
echo "tskey-..." > /mnt/us/koreader/plugins/tailscale.koplugin/bin/auth.key  # or /mnt/onboard/.adds/koreader/plugins/tailscale.koplugin/bin/auth.key
```

### 5. Start Tailscale

Return to KOReader and use the plugin menu to start Tailscale.

## Troubleshooting

Check `bin/tailscaled.log` and `bin/tailscale.log` in the plugin directory. See [NOTES.md](NOTES.md) for internals and manual installation.

## Credits

Based on [mitanshu7/tailscale_kual](https://github.com/mitanshu7/tailscale_kual). MIT License.

koreader-tailscale

koreader-tailscale Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

koreader-tailscale

koreader-tailscale Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README