rmfakecloud is fake of the cloud sync the remarkable tablet is using, in case you want to sync/backup your files and have full control of the hosting/storage environment and don't trust Google/.
early prototype (sync and notifications work). no security and a lot of quick and dirty hacks. currently only a single device is "supported" to work reliably i.e. clients not distingished due to the lack of auth
Install and build the project:
go get -u github.com/ddvk/rmfakecloud
run
~/go/bin/rmfakecloud
or clone an do: go run .
or make run
or make all artifacts are in the dist folder. the Arm binaries work on pi3 / Synology etc
or make docker && ./rundocker.sh
env variables:
PORT port number (default: 3000)
DATA_DIR to set data/files directory (default: data in current dir)
STORAGE_URL the storage url resolvable from the device (default: http://hostname:port)
In order to get hwr running with myScript register for a developer account and set the env variables:
HWR_APPLICATIONKEY
RMAPI_HWR_HMAC
Define the following env variables (only gmail has been tested):
RM_SMTP_SERVER e.g. smtp.gmail.com:465
RM_STMP_USERNAME
RM_STMP_PASSWORD (colud try with app password)
all needed artifacts are in device/ folder
Install a root CA on the device, you can use the device/gencert.sh script
- generate a CA and host certificate for *.appspot.com
- create the CA folder:
mkdir -p /usr/local/share/ca-certificates - copy the CA.crt file to
/usr/local/share/ca-certificatesand runupdate-ca-certificates - modify the hosts file
/etc/hosts- so the options are:
- run a reverse https proxy on the rm tablet as a service, e.g. secure
-
stop xochitl
systemctl stop xochitl -
add to /etc/hosts
127.0.0.1 service-manager-production-dot-remarkable-production.appspot.com 127.0.0.1 local.appspot.com 127.0.0.1 my.remarkable.com -
set the address of your api host:port in the reverse proxy
secure -cert proxy.crt -key proxy.key http://host_where_the_api_is_running:3000or use the provided systemd unit file and put the config in proxycfg -
run the host
-
run
fixsync.shon the device to mark all files as new (not to be deleted from the device) -
start xochitl
systemctl start xochitl
-
- run the fakeapi on port 443 with a certificate signed by the CA you installed
- modify the hosts files to point to this host 8328
- install only the CA certificate on the device
- modify your DNS Server/router to resolve the aforementioned addesses to a https reverse proxy
- install the hosts certificate on the proxy and route to the api e.g:
- on a ubiquity router /etc/dnsmasq.d/rm.conf address=/my.remarkable.com/192.168.0.10 etc
- on a synology there is an application portal which you can configure as a reverse proxy
- CONS this will affect ALL devices, but you use the mobile apps and windows clients without modifications
- run a reverse https proxy on the rm tablet as a service, e.g. secure
- so the options are:
- connecting to the api will delete all your files, unless you mark them as not synced
synced:falseprior to syncing
- auth / authz
- multi tenant
- fix go stuff
- storage providers (dropbox, fs etc)
- db (fs, sqlite etc)
- liveview
- ui (react)
- ut
- ci/cd
- refactor
(my interpretation and flawed observations)
Given a new unregistered device, all the files that are generated locally have a status synced:false
Registration:
the device sends a post request to: my.remarkable.com/token/json/2/device/new
containing the random key (currently any key will be accepted) and gets a device token
with the device token it obtains expiring access tokens: my.remarkable.com/token/json/2/user/new
having a user access token:
sends a request to the services locator to get the urls of additional services:
/service/json/1/(web|mail|notification|storage)(now always local.appspot.com)
it gets a list of all documents
Gets the list of documents from the server: /document-storage/json/2/docs
the order may be not correct at all:
- deletes all documents not in the list and having
synced: false - deletes all documents from the cloud that have
deleted: true - applies renames, page changes
- sends all new and marks them
synced: true - sends all modified documents (having a greater Version number?)
- it doesn't re-download any changed/newer documents
So if you just point the device to a new empty server, all documents will be deleted from the device. Going back will again, delete all documents and put what was on the server
-
check the connectivity between the tablet and the host: ping my.remarkable.com (should be localhost) ping local.remarkable.com (should be localhost) ping thehostpc wget -qO- http://host:3000 (or relevant ports, should get Working...) wget -qO- https://local.appspot.com (should get Working...)
-
if both (host and tablet) are on a wifi make sure "Client Isolation" is not actived on the AP
-
check if the proxy is configured correctly systemctl status proxy (or the logs)
-
check if the CA cert was correctly installed when doing
update-ca-certificatesthere should have been1 addedcheck the logs -
check xochitls's logs, stop the service, start manually with more logging
systemct stop xochtilQT_LOGGING_RULES=xochitl.*=true xochitl | grep -A3 QUrl