{"id":13771499,"url":"https://github.com/polletfa/rmWebUI","last_synced_at":"2025-05-11T04:30:44.816Z","repository":{"id":44953760,"uuid":"441569595","full_name":"polletfa/rmWebUI","owner":"polletfa","description":"WebUI for the reMarkable(R) cloud","archived":false,"fork":false,"pushed_at":"2022-01-16T22:26:13.000Z","size":2384,"stargazers_count":2,"open_issues_count":27,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-17T07:34:13.299Z","etag":null,"topics":["remarkable-tablet"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/polletfa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-24T23:12:27.000Z","updated_at":"2024-04-15T06:01:13.000Z","dependencies_parsed_at":"2022-09-11T07:11:24.767Z","dependency_job_id":null,"html_url":"https://github.com/polletfa/rmWebUI","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polletfa%2FrmWebUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polletfa%2FrmWebUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polletfa%2FrmWebUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polletfa%2FrmWebUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/polletfa","download_url":"https://codeload.github.com/polletfa/rmWebUI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253518941,"owners_count":21921074,"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-08-03T17:00:52.134Z","updated_at":"2025-05-11T04:30:44.011Z","avatar_url":"https://github.com/polletfa.png","language":"PHP","funding_links":[],"categories":["GUI Clients"],"sub_categories":["Template Builders"],"readme":"# rmWebUI\n\nrmWebUI is a simple web interface for the reMarkable\u0026reg; cloud designed primarily for small screens. It includes the following features:\n\n- Register application\n- Browse collections\n- Refresh collections\n- Download a document as ZIP (original data)\n- Download a document as PDF (convert using [rmrl](https://github.com/rschroll/rmrl))\n- Cache downloaded files based on version. Download from the cloud only as needed.\n- [Demonstration mode](http://frmpollet.me/rmWebUI-demo/)\n\n![register](./screenshots/register.png)\n![register-failed](./screenshots/register-failed.png)\n![list-root](./screenshots/list-root.png)\n![list-open-item](./screenshots/list-open-item.png)\n![list-downloading](./screenshots/list-downloading.png)\n![list-download](./screenshots/list-download.png)\n\n# Install\n\n## Prepare the distribution files\n\nRun:\n\n```\ncomposer run deploy\n```\n\nThis will create a `dist/` folder with all required files.\n\n## Configure\n\nThe file `data/config.json` contains a few configuration options:\n\n- `mode`: Either `debug` or `prod`. In debug mode, PHP error messages will be activated.\n- `cache`: If true, files will be cached and only downloaded/converted as needed. This will allow faster access but will use space on your webserver.\n- `rmrl`: By default, notebooks are downloaded as a ZIP file containing the metadata and lines files in the proprietary format of reMarkable\u0026reg;. rmWebUI is also capable of converting the files to PDF by using [rmrl](https://github.com/rschroll/rmrl). To activate this feature, use this option to specify the command for running rmrl (typically it should be `python -m rmrl` or `python3 -m rmrl` but it may differ depending on your system configuration). Be aware that RMRL has limitations and may not work properly with some documents. When this feature is configured, both ZIP and PDF downloads are available.\n\n## Prepare the webserver\n\nYou need a webserver with PHP 7.2 or further.\n\nIf you use RMRL, you also need to install Python 3.7 or further and [rmrl](https://github.com/rschroll/rmrl). Make sure to install rmrl as either root or the user running the webserver.\n\n## Deploy\n\nCopy the content of the `dist/` folder to your webserver and make sure the webserver has write permission to `data/`.\n\n## Important security warning\n\nrmWebUI doesn't implement any kind of authentication. Configure your webserver as needed to prevent unauthorized access, for example by using a `.htaccess` file (for Apache). Make sure that subdirectories and files are protected as well (especially `data/` and `data/cache/`).\n\nFor example, you can put the following `.htaccess` file into the base directory of rmWebUI:\n```\nAuthType Basic\nAuthName \"rmWebUI\"\nAuthUserFile /var/www/.htpasswd\nRequire valid-user\n\nRewriteOptions InheritDown\n```\n\nand create the password file `/var/www/.htpasswd`.\n\nSee the Apache documentation for more information:\n\n- [Authentication and Authorization](https://httpd.apache.org/docs/2.4/howto/auth.html)\n- [htpasswd](https://httpd.apache.org/docs/2.4/programs/htpasswd.html)\n\n# Register application\n\nOn the first run, you will be asked to register the application. This is required to access your files on the reMarkable\u0026reg; cloud. Once the application is registered, you don't need to do it again. You will be asked again if the application fails to connect to the cloud or if you clear the content of the file `data/auth.json`.\n\n# Live demo\n\nrmWebUI also has a special demonstration mode that can be used to demonstrate the application without access to a reMarkable\u0026reg; cloud account. In this mode, dummy data are returned and rmrl is not used.\n\nTo install the demo mode, run `composer run demo` instead of `composer run deploy`. The files are created in `demo/`. You don't need to install rmrl to get PDFs (but you still need to set a value in the configuration to enable the feature). You also don't need write access to `data/`.\n\n# License\n\n\u0026copy; 2021-2022 Fabien Pollet \u003cpolletfa@posteo.de\u003e\n\nrmWebUI is licensed under the MIT license. See the LICENSE file for details.\n\n# Trademarks\n\nreMarkable\u0026reg; is a registered trademark of reMarkable AS. rmWebUI is not affiliated with, or endorsed by, reMarkable AS. The use of “reMarkable” in this work refers to the company’s e-paper tablet product(s).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolletfa%2FrmWebUI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolletfa%2FrmWebUI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolletfa%2FrmWebUI/lists"}