{"id":23581120,"url":"https://github.com/hmenzagh/rmpp-entware","last_synced_at":"2025-11-02T13:30:36.375Z","repository":{"id":269334367,"uuid":"907047242","full_name":"hmenzagh/rmpp-entware","owner":"hmenzagh","description":"RMPP Entware allows you to install additional software packages from the Entware repositories on your reMarkable device.","archived":false,"fork":false,"pushed_at":"2025-01-15T11:47:25.000Z","size":17,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-15T13:37:09.981Z","etag":null,"topics":["remarkable-tablet"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hmenzagh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-22T17:00:03.000Z","updated_at":"2025-01-15T11:47:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c9b2043-c146-415c-a6dd-4475175c0b82","html_url":"https://github.com/hmenzagh/rmpp-entware","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"7ea6550a5db48d2dacb01907a70907a7fb4e94ba"},"previous_names":["hmenzagh/rmpp-entware"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2Frmpp-entware","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2Frmpp-entware/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2Frmpp-entware/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2Frmpp-entware/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hmenzagh","download_url":"https://codeload.github.com/hmenzagh/rmpp-entware/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239394628,"owners_count":19631122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["remarkable-tablet"],"created_at":"2024-12-27T00:14:23.466Z","updated_at":"2025-11-02T13:30:36.301Z","avatar_url":"https://github.com/hmenzagh.png","language":"Shell","funding_links":[],"categories":["Shell","Other"],"sub_categories":["Template Builders"],"readme":"[![rmpp](https://img.shields.io/badge/rMPP-supported-green)](https://remarkable.com/store/overview/remarkable-paper-pro)\n# RMPP Entware\n\n**RMPP Entware** allows you to install additional software packages from the [Entware](https://github.com/Entware/Entware) repositories on your reMarkable device. This enhances your device's functionality through a lightweight package manager designed for embedded systems.\n\n\u003e **Special Thanks:**  \n\u003e I extend my gratitude to [Evidlo](https://github.com/Evidlo) for his original work on [remarkable_entware](https://github.com/Evidlo/remarkable_entware), which served as the foundation to this script.\n\n## Table of Contents\n\n- [Features](#features)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n  - [Step 1: Connect Your reMarkable](#step-1-connect-your-remarkable)\n  - [Step 2: Access via SSH](#step-2-access-via-ssh)\n  - [Step 3: Run the Installer](#step-3-run-the-installer)\n- [Usage](#usage)\n  - [Installing Packages](#installing-packages)\n  - [Searching for Packages](#searching-for-packages)\n- [Managing Updates](#managing-updates)\n  - [After a Firmware Update](#after-a-firmware-update)\n- [Cleanup](#cleanup)\n- [Additional Information](#additional-information)\n  - [PATH Configuration](#path-configuration)\n  - [Toltec Compatibility](#toltec-compatibility)\n- [Managing Packages with Opkg](#managing-packages-with-opkg)\n- [Final Notes](#final-notes)\n  - [System Compatibility](#system-compatibility)\n  - [Safety Precautions](#safety-precautions)\n  - [Support Disclaimer](#support-disclaimer)\n- [Support](#support)\n\n## Features\n\n- **Extended Functionality:** Install a wide range of packages from Entware repositories.\n- **RMPP Support:** Tailored for devices running the RMPP firmware.\n- **Persistent Installation:** Remains intact even after firmware updates.\n\n## Prerequisites\n\nBefore installing reMarkable Entware, ensure you have the following:\n\n- **reMarkable Device:** Ensure your device is running the RMPP firmware.\n- **USB Connection:** A USB cable to connect your reMarkable to your computer.\n- **Internet Access:** The device must be connected to the internet.\n- **SSH Access:** Ability to access your device via SSH.\n\n## Installation\n\nFollow these steps to install RMPP Entware on your device.\n\n### Step 1: Connect Your reMarkable\n\n1. **Connect via USB:** Use a USB cable to connect your reMarkable device to your computer.\n2. **Ensure Internet Access:** Verify that your device is connected to the internet to download necessary packages.\n\n### Step 2: Access via SSH\n\n1. **Enable SSH:** If not already enabled, follow [these instructions](https://remarkable.guide/guide/access/index.html) to enable SSH on your reMarkable (dev mode).\n2. **Connect to SSH:** Use an SSH client to connect to your device. For example:\n   ```bash\n   ssh root@\u003cyour-device-ip\u003e\n   ```\n\n### Step 3: Run the Installer\n\nExecute the installation script to set up Entware on your device.\n\n#### Standard Installation\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash\n```\n\n#### Force Installation (Bypass Prompts)\n\nIf you prefer a non-interactive installation that automatically answers to prompts:\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --force\n```\n\n#### Cleanup Installation (Remove Existing Entware)\n\nTo remove any partial or existing Entware installation:\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --cleanup\n```\n\n##### Force Cleanup (No Prompts)\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --cleanup --force\n```\n\n#### Re-enable Entware After Firmware Update\n\n\u003e **Warning:** This part of the script has not been tested yet \u0026 may not work as expected.\nAfter updating your device's firmware, Entware remains safe in `/home/root/.entware`. To remount `/opt` and re-enable Entware:\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --reenable\n```\n\n##### Force Re-enable (No Prompts)\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --reenable --force\n```\n\n\u003e **Note:** The base installation requires approximately **13MB** of space. All Entware data is stored in `/opt`, which is bind-mounted to `/home/root/.entware` to optimize space usage on the root partition.\n\n## Usage\n\nOnce installed, you can manage packages using the `opkg` package manager.\n\n### Installing Packages\n\nTo install a package, use the following command:\n\n```bash\nopkg install \u003cpackage_name\u003e\n```\n\n**Example: Install Git**\n\n```bash\nopkg install git\n```\n\n### Searching for Packages\n\nTo search for available packages, use:\n\n```bash\nopkg find '\u003csearch_term\u003e'\n```\n\n**Example: Search for Packages Related to 'top'**\n\n```bash\nopkg find '*top*'\n```\n\n## Managing Updates\n\n### After a Firmware Update\n\nFirmware updates might overwrite data outside `/home/root`. However, Entware remains safe in `/home/root/.entware`. To ensure Entware remains functional:\n\n1. **Remount `/opt`:**\n\n   ```bash\n   wget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --reenable\n   ```\n\n2. **Force Re-enable (No Prompts):**\n\n   ```bash\n   wget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --reenable --force\n   ```\n\n## Cleanup\n\nIf you need to remove Entware from your device, follow these steps.\n\n### Remove Entware\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --cleanup\n```\n\n#### Force Cleanup (No Prompts)\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --cleanup --force\n```\n\n### Free Up Disk Space\n\nTo free up space on the root partition by cleaning up system logs:\n\n```bash\njournalctl --vacuum-size=2M\n```\n\n## Additional Information\n\n### PATH Configuration\n\nDuring installation, the script can automatically add `/opt/bin` and `/opt/sbin` to your `PATH`. If you skipped this step or used the `--force` option, you can manually update your `PATH`:\n\n1. **Add to PATH:**\n\n   ```bash\n   export PATH=/opt/bin:/opt/sbin:$PATH\n   ```\n\n2. **Apply Changes:**\n\n   ```bash\n   source ~/.bashrc\n   ```\n\n### Toltec Compatibility\n\n- **Compatibility Limitation:** [Toltec](https://github.com/toltec-dev/toltec) is not supported on firmware versions above **3.3.2.1666** (as of 2024-12-22).\n- **RMPP Users:** Toltec is currently not viable for RMPP users.\n\n## Managing Packages with Opkg\n\nUse `opkg` to manage your Entware packages effectively.\n\n### Update Package List\n\n```bash\nopkg update\n```\n\n### Install a Package\n\n```bash\nopkg install \u003cpackage_name\u003e\n```\n\n### Remove a Package\n\n```bash\nopkg remove \u003cpackage_name\u003e\n```\n\n### Upgrade Installed Packages\n\n```bash\nopkg upgrade\n```\n\n## Final Notes\n\n### System Compatibility\n\n- **Supported Devices:** This installer is specifically designed for **RMPP** devices.\n  \n### Safety Precautions\n\n- **Avoid Interruptions:** Do not power off your device during the installation process to prevent potential system corruption.\n\n### Support Disclaimer\n\n- **Use at Your Own Risk:** I am not responsible for any damage or issues arising from the use of this software.\n- **No Guaranteed Support:** While I will try to help \u0026 update the script, support is limited.\n\n**Happy hacking!**\n\nFor more detailed information about script usage and available options, run:\n\n```bash\nwget -O - http://raw.githubusercontent.com/hmenzagh/rmpp-entware/main/rmpp_entware.sh | bash -s -- --help\n```\n\n## Support\n\nIf you encounter issues or have questions, consider the following resources:\n- **Documentation:** Refer to the [Entware Wiki](https://github.com/Entware/Entware/wiki) for comprehensive guides.\n- **Remarkable.Guide:** [reMarkable.Guide](https://remarkable.guide/) is a great resource to learn more about the reMarkable devices.\n\n---\n\n**Disclaimer:** Always ensure you have backups of important data before making significant changes to your device. Proceed with caution and at your own risk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmenzagh%2Frmpp-entware","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmenzagh%2Frmpp-entware","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmenzagh%2Frmpp-entware/lists"}