Skip to content

Commit 1c95f2c

Browse files
committed
Add guide for using the rmfakecloud-proxy
This PR adds a detailed step-by-step guide to setting up rmfakecloud-proxy on a device (see toltec-dev/toltec#448). It is to be merged when the package reaches the stable branch.
1 parent a2d7801 commit 1c95f2c

File tree

6 files changed

+130
-14
lines changed

6 files changed

+130
-14
lines changed
68.6 KB
Loading

src/_themes/toltec/layout.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
1212
{%- endif %}
1313

14-
<link rel="stylesheet" href="_static/toltec.css">
15-
<link rel="icon" href="_static/images/favicon.png" type="image/png">
16-
<link rel="icon" href="_static/images/favicon.svg" sizes="any" type="image/svg+xml">
14+
<link rel="stylesheet" href="/_static/toltec.css">
15+
<link rel="icon" href="/_static/images/favicon.png" type="image/png">
16+
<link rel="icon" href="/_static/images/favicon.svg" sizes="any" type="image/svg+xml">
1717
</head>
1818
<body>
1919
<aside class="sidebar">
2020
<header class="sidebar-header">
2121
<a href="/">
22-
<img alt="" src="_static/images/toltec-small.svg"
22+
<img alt="" src="/_static/images/toltec-small.svg"
2323
class="sidebar-logo">
2424
<span class="sidebar-sitename">{{ project }}</span>
2525
</a>

src/_themes/toltec/static/toltec.css

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
--font: "-apple-system", "BlinkMacSystemFont",
1111
"Helvetica Neue", "Roboto", sans-serif;
1212
--font-color: #222;
13-
--font-color-dim: #777;
13+
--font-color-dim: #666;
1414
--font-color-inv: #fcfaf8;
1515

1616
/* Text sizes */
@@ -82,13 +82,16 @@ html {
8282
}
8383
}
8484

85+
pre, code {
86+
font-size: 0.888rem;
87+
}
88+
8589
pre {
8690
padding: var(--text-height);
87-
background-color: var(--bg-color-inv);
8891
overflow: auto;
8992
border-radius: var(--border-radius);
9093

91-
font-size: 0.888rem;
94+
background-color: var(--bg-color-inv);
9295
color: var(--font-color-inv);
9396
}
9497

@@ -246,18 +249,35 @@ main {
246249
.sidebar-nav ul ul {
247250
margin:
248251
0 0 var(--text-height)
249-
calc(.5 * var(--text-height));
252+
calc(1 * var(--text-height));
250253
}
251254

252-
.sidebar-nav > ul > li > ul > li a::before {
253-
content: "";
255+
.sidebar-nav li li a::before {
256+
--width: calc(0.66 * var(--text-height));
257+
margin-left: calc(-1 * var(--width));
258+
width: var(--width);
259+
260+
content: "\25B6";
254261
display: inline-block;
255262

263+
font-size: 0.66rem;
256264
vertical-align: 10%;
257-
border-top: 0.222rem solid transparent;
258-
border-bottom: 0.222rem solid transparent;
259-
margin-right: 0.444rem;
260-
border-left: 0.444rem solid currentColor;
265+
}
266+
267+
/* Match internal links, except links to the current page */
268+
.sidebar-nav a[href^="#"]:not([href$="#"]) {
269+
color: var(--font-color-dim);
270+
}
271+
272+
.sidebar-nav a[href^="#"]:not([href$="#"])::before {
273+
content: "#";
274+
font-size: 1rem;
275+
vertical-align: 0%;
276+
}
277+
278+
.sidebar-nav a.current {
279+
font-weight: bold;
280+
text-decoration-thickness: 0.1rem;
261281
}
262282

263283
.sidebar-footer {
@@ -284,6 +304,14 @@ main > section:first-of-type > h1:first-of-type {
284304
border-radius: var(--border-radius);
285305
}
286306

307+
figure {
308+
margin: var(--page-spacing) 0;
309+
}
310+
311+
figcaption {
312+
font-style: italic;
313+
}
314+
287315
/* Small screens */
288316

289317
@media (max-width: 1024px) {

src/guides.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
======
2+
Guides
3+
======
4+
5+
.. toctree::
6+
:glob:
7+
:maxdepth: 1
8+
9+
guides/*

src/guides/rmfakecloud.rst

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
===================================
2+
Connecting to an rmfakecloud Server
3+
===================================
4+
5+
Using `rmfakecloud <https://github.com/ddvk/rmfakecloud>`_, you can synchronize your notes and documents between Xochitl (the default reMarkable app) and alternative cloud servers.
6+
Among other benefits, this **puts you back in control** of your data, allows you to **setup automated backups** on the server side, and gives you a web-based interface to browse your notes.
7+
8+
.. figure:: /_static/images/rmfakecloud-web-interface.png
9+
:width: 100%
10+
:class: screenshot
11+
12+
rmfakecloud’s web interface
13+
14+
This page will guide you through the steps needed to connect your device to an rmfakecloud server using Toltec.
15+
16+
*Note: You can only be connected to one server at a time.*
17+
*You will not be able to connect to the reMarkable cloud service and an rmfakecloud server simultaneously.*
18+
*It is easy to* `switch between servers <#switching-to-a-different-server>`_, *though.*
19+
20+
Before Getting Started
21+
----------------------
22+
23+
First, make sure you **have access to an account on any rmfakecloud instance**.
24+
You can set up your own instance by following the `instructions from the repository <https://github.com/ddvk/rmfakecloud>`_.
25+
Take note of the server address; in the following, we’ll use ``https://rmfakecloud.example.com`` as an example server address.
26+
27+
It’s also a good idea to **make a full backup of your data** before following the steps below.
28+
Make sure you’ve synced your documents with the reMarkable cloud service, as you will get disconnected during the process.
29+
The simplest way to make a backup is to `copy the contents <https://remarkablewiki.com/tech/file_transfer>`_ of ``/home/root/.local/share/remarkable`` (on your device) to a safe location.
30+
31+
Installing the Proxy
32+
--------------------
33+
34+
Xochitl does not have built-in support for alternative servers, so we need to trick the app into *believing* it’s connecting to the main reMarkable servers even though it’s actually connecting to your server of choice.
35+
Fortunately, Toltec provides a package that automates all these steps for you.
36+
Start an `SSH session <https://remarkablewiki.com/tech/ssh>`_ to your device and type the following command at the prompt::
37+
38+
opkg install rmfakecloud-proxy
39+
40+
Once the package is installed, select a server to connect to::
41+
42+
rmfakecloudctl set-upstream https://rmfakecloud.example.com
43+
44+
Finally, run the command below to switch to that server.
45+
This will disconnect you from the cloud (if you were connected), create a local self-signed certificate authority, and start a proxy that forwards any request directed to the official servers towards your selected server::
46+
47+
rmfakecloudctl enable
48+
49+
If all goes well, you should get a message saying *“rmfakecloud-proxy is now enabled”* in your terminal.
50+
51+
Logging in to Your Account
52+
--------------------------
53+
54+
Congratulations, your device is now talking to your rmfakecloud server of choice!
55+
The last remaining step is to login to your account exactly as if you were connecting to your reMarkable account.
56+
57+
On your computer, browse to your rmfakecloud server’s web interface, login, then go to the *Code* tab to retrieve an eight-letter one-time-code.
58+
On your device, go to *Menu > Settings > Account > Connect to reMarkable cloud > Connect*, then input that code.
59+
60+
Once this is done, you’re all set! Note that the initial sync may take some time as it will upload all your documents to the new server.
61+
62+
Switching to a Different Server
63+
-------------------------------
64+
65+
Once the rmfakecloud proxy is setup on your device, you can switch to any other rmfakecloud instance by doing::
66+
67+
rmfakecloud set-upstream https://other-rmfakecloud.example.com
68+
69+
Each server switch will disconnect you from the cloud, so you’ll need to log back in to your respective accounts.
70+
71+
Reverting Back to the reMarkable Servers
72+
----------------------------------------
73+
74+
It’s easy to revert back to syncing with the reMarkable cloud service, just run the following command::
75+
76+
rmfakecloud disable
77+
78+
After the uninstallation process completes, head to *Menu > Settings > Account > Connect to reMarkable cloud > Connect* again and input a login code from the official servers to log back in to your account.

src/sitemap.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. toctree::
22

33
index
4+
guides
45
Packages <https://toltec-dev.org/stable>
56
Entware Packages <https://bin.entware.net/armv7sf-k3.2/Packages.html>

0 commit comments

Comments
 (0)