codedward / morningpaper2remarkable Goto Github PK

View Code? Open in Web Editor NEW

A bot to sync the morning paper to a remarkable tablet.

License: MIT License

Dockerfile 3.78% Makefile 29.83% Go 66.40%

morningpaper2remarkable's Introduction

morningpaper2remarkable

A bot to sync the morning paper to a remarkable tablet.

This authenticates with your remarkable cloud account via the command line on start. I hope to eventually make it run on my remarkable and not have to deal with the cloud.

Table of Contents

Installation
Usage

Installation

Binaries

For installation instructions from binaries please visit the Releases Page.

Via Go

$ go get github.com/jessfraz/morningpaper2remarkable

Running with Docker

Authentication

$ touch ${HOME}/.rmapi

$ docker run --rm -it \
    --name morningpaper2remarkable \
    -v "${HOME}/.rmapi:/home/user/.rmapi:rw" \
    r.j3ss.co/morningpaper2remarkable --once

# Enter your one time auth code.

Run it in daemon mode with our auth code

# You need to have already authed and have a .rmapi api file for this to 
# work in daemon mode.
$ docker run -d --restart always \
    --name morningpaper2remarkable \
    -v "${HOME}/.rmapi:/home/user/.rmapi:ro" \
    r.j3ss.co/morningpaper2remarkable --interval 20h

Usage

$ morningpaper2remarkable -h
morningpaper2remarkable -  A bot to sync the morning paper to a remarkable tablet.

Usage: morningpaper2remarkable <command>

Flags:

  -d, --debug  enable debug logging (default: false)
  --dir        directory to store the downloaded papers in (default: morningpaper)
  --interval   update interval (ex. 5ms, 10s, 1m, 3h) (default: 18h)
  --once       run once and exit, do not run as a daemon (default: false)

Commands:

  version  Show the version information.

Recommend Projects