Sign inSign up

gordlea/remarkable-raindrop

By gordlea

•Updated over 4 years ago

Sync items from your raindrop.io account to your remarkable tablet in pdf format.

Image
0

525

gordlea/remarkable-raindrop repository overview

⁠remarkable-raindrop

Github Repo: https://github.com/gordlea/remarkable-raindrop⁠

A service that will sync items from your raindrop.io account to your remarkable tablet in pdf format.

It will watch your raindrop.io account for any items with a certain tag (by default: on_remarkable), and when it finds them, it will simplify the html (using outline.com for now), convert to pdf, then upload to your remarkable account via the cloud api.

⁠Prerequisites

Before you begin, you will need both your remarkable device token, and a raindrop api test token for your account.

⁠How to get your Remarkable Device Token
  1. Generate a new uuid for your deviceId. You can do this by running uuidgen on the cli, or by going to one of many online uuid generators⁠. This will be your deviceId.

  2. Grab a one time code by going to (https://my.remarkable.com/#desktop⁠).

  3. Make a post request to the remarkable api to generate new device token:

    # example using curl
    curl -X "POST" "https://webapp-production-dot-remarkable-production.appspot.com/token/json/2/device/new" \
        -H 'Content-Type: application/json' \
        -d $'{
    "deviceDesc": "desktop-windows",
    "deviceID": "put your generated deviceId here",
    "code": "<place one time code from step 2 here"
    }'
    
⁠How to get your Raindrop API Test Token
  1. Log into your raindrop.io account in the browser, then go to (https://app.raindrop.io/settings/integrations⁠)

  2. Down at the bottom, under "For Developers", click create new app.

  3. Give it a name, accept the terms, and click create

  4. Click on the newly created app, and the under "Credentials" click on "Create test token".

⁠Run using docker / docker-compose

The docker image uses cron to periodically check for new raindrop.io items.

⁠Docker Run
docker run \
    --env RMKDROP_REMARKABLE_DEVICE_TOKEN=<deviceToken from above> \
    --env RMKDROP_RAINDROP_TEST_TOKEN=<raindrop test token from above> \
    -it gordlea/remarkable-raindrop
⁠Docker Compose

Example docker-compose.yml

version: "3.8"
    
services:
  remarkable_raindrop:
      image: gordlea/remarkable-raindrop:latest
      environment:
       - RMKDROP_REMARKABLE_DEVICE_TOKEN=<deviceToken from above> 
       - RMKDROP_RAINDROP_TEST_TOKEN=<raindrop test token from above>
⁠Additional Configuration

You can run yarn start --help for detailed information on cli options.

cli optionenv vardefaultdescription
--raindrop-test-tokenRMKDROP_RAINDROP_TEST_TOKENno default, requiredYour raindrop.io api test token. See How to get your Raindrop API Test Token⁠ above.
--raindrop-searchRMKDROP_RAINDROP_SEARCH#on_remarkableThis is the search query used to determine which items in your raindrop.io account to send to your remarkable tablet. See https://help.raindrop.io/using-search/#operators⁠ for more information. Basically any raindrop item in your account that matches this search will be copied to your tablet.
--log-levelRMKDROP_LOG_LEVELinfoOne of [error, warn, info, debug, trace]. This sets how verbose you want the log output to be.
--remarkable-device-tokenRMKDROP_REMARKABLE_DEVICE_TOKENno default, requiredYour remarkable device token. See How to get your Remarkable Device Token⁠ above.
--remarkable-directoryRMKDROP_REMARKABLE_DIRECTORYraindrop.ioThe name of the directory on your remarkable device where pdfs will be placed.
RMKDROP_CRON*/10 * * * *This option is only available when running the docker container. This sets the cron expression that determines how often the docker container will check raindrop.io for updates. The default is 10 minutes. See https://crontab.guru/⁠.

Tag summary

Content type

Image

Digest

Size

420 MB

Last updated

over 4 years ago

docker pull gordlea/remarkable-raindrop