https://github.com/Davide95/remarkaBot

Fetch your documents from Telegram to your Remarkable 2!
https://github.com/Davide95/remarkaBot

golang remarkable remarkable-2 remarkable-tablet telegram-bot

Last synced: 25 days ago
JSON representation

Fetch your documents from Telegram to your Remarkable 2!

• Host: GitHub
• URL: https://github.com/Davide95/remarkaBot
• Owner: Davide95
• License: gpl-3.0
• Archived: true
• Created: 2021-10-02T15:06:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-03T20:44:31.000Z (about 3 years ago)
• Last Synced: 2024-08-03T17:09:33.159Z (4 months ago)
• Topics: golang, remarkable, remarkable-2, remarkable-tablet, telegram-bot
• Language: Go
• Homepage: https://gitlab.com/mollofrollo/remarkabot
• Size: 186 KB
• Stars: 12
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-reMarkable - remarkaBot - Fetch your documents from Telegram. (Applications / Other APIs)

README

        
# remarkaBot

Fetch your documents from Telegram to your reMarkable 2!

This program will fetch new documents every 10 minutes for you :)

## Installation

### Telegram

In order to user `remarkaBot` you need a Telegram Bot, you can create one using [BotFather](https://t.me/BotFather).  

Sending private messages to him is not allowed. For security reasons it's crucial that you are in control of the groups `remarkaBot` accepts files from. To make sure nobody adds your `remarkaBot` instance to some random (potentially malicious) groups we reccomend to block all group invitations after having added the bot to your groups. You can simply do that by sending `/setjoingroups` to `BotFather` and follow instructions. 

From now on to add `remarkaBot` to other groups you must unlock group invitations and lock it again.   

Leaving the setting unlocked might be tempting, but **please** don't do that.

Consider to disable `/setprivacy` to send documents to `remarkaBot` without having to mention him.

### remarkaBot

You first need to connect your reMarkable 2 to your PC to allow an SSH connection (see https://support.remarkable.com/hc/en-us/articles/360002662557-Help to understand how).

You also need to have the Go compiler installed on your PC.

Steps to install it:

* `git clone -c core.autocrlf=false https://gitlab.com/mollofrollo/remarkabot.git`

* edit the `systemd/.env` file to put your Bot's token

* `sh scripts/install.sh $RM2IP` on Linux or `.\scripts\install.bat $RM2IP` on Windows, where `$RM2IP` is the IP of the connected reMarkable 2

Each time the device is updated, you need to reinstall remarkaBot.

Grab the opportunity to update the repo first (`git pull`).

## Acknowledgment

Contributors:

* Davide Riva  (Mantainer)

* Laura Nesossi  (logo creator)

* Roberto Castellotti