Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide for using the rmfakecloud-proxy package #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/_static/images/rmfakecloud-web-interface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions src/_themes/toltec/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endif %}

<link rel="stylesheet" href="_static/toltec.css">
<link rel="icon" href="_static/images/favicon.png" type="image/png">
<link rel="icon" href="_static/images/favicon.svg" sizes="any" type="image/svg+xml">
<link rel="stylesheet" href="/_static/toltec.css">
<link rel="icon" href="/_static/images/favicon.png" type="image/png">
<link rel="icon" href="/_static/images/favicon.svg" sizes="any" type="image/svg+xml">
</head>
<body>
<aside class="sidebar">
<header class="sidebar-header">
<a href="/">
<img alt="" src="_static/images/toltec-small.svg"
<img alt="" src="/_static/images/toltec-small.svg"
class="sidebar-logo">
<span class="sidebar-sitename">{{ project }}</span>
</a>
Expand Down
48 changes: 38 additions & 10 deletions src/_themes/toltec/static/toltec.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
--font: "-apple-system", "BlinkMacSystemFont",
"Helvetica Neue", "Roboto", sans-serif;
--font-color: #222;
--font-color-dim: #777;
--font-color-dim: #666;
--font-color-inv: #fcfaf8;

/* Text sizes */
Expand Down Expand Up @@ -82,13 +82,16 @@ html {
}
}

pre, code {
font-size: 0.888rem;
}

pre {
padding: var(--text-height);
background-color: var(--bg-color-inv);
overflow: auto;
border-radius: var(--border-radius);

font-size: 0.888rem;
background-color: var(--bg-color-inv);
color: var(--font-color-inv);
}

Expand Down Expand Up @@ -246,18 +249,35 @@ main {
.sidebar-nav ul ul {
margin:
0 0 var(--text-height)
calc(.5 * var(--text-height));
calc(1 * var(--text-height));
}

.sidebar-nav > ul > li > ul > li a::before {
content: "";
.sidebar-nav li li a::before {
--width: calc(0.66 * var(--text-height));
margin-left: calc(-1 * var(--width));
width: var(--width);

content: "\25B6";
display: inline-block;

font-size: 0.66rem;
vertical-align: 10%;
border-top: 0.222rem solid transparent;
border-bottom: 0.222rem solid transparent;
margin-right: 0.444rem;
border-left: 0.444rem solid currentColor;
}

/* Match internal links, except links to the current page */
.sidebar-nav a[href^="#"]:not([href$="#"]) {
color: var(--font-color-dim);
}

.sidebar-nav a[href^="#"]:not([href$="#"])::before {
content: "#";
font-size: 1rem;
vertical-align: 0%;
}

.sidebar-nav a.current {
font-weight: bold;
text-decoration-thickness: 0.1rem;
}

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

figure {
margin: var(--page-spacing) 0;
}

figcaption {
font-style: italic;
}

/* Small screens */

@media (max-width: 1024px) {
Expand Down
9 changes: 9 additions & 0 deletions src/guides.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
======
Guides
======

.. toctree::
:glob:
:maxdepth: 1

guides/*
78 changes: 78 additions & 0 deletions src/guides/rmfakecloud.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
===================================
Connecting to an rmfakecloud Server
===================================

Using `rmfakecloud <https://github.com/ddvk/rmfakecloud>`_, you can synchronize your notes and documents between Xochitl (the default reMarkable app) and alternative cloud servers.
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.

.. figure:: /_static/images/rmfakecloud-web-interface.png
:width: 100%
:class: screenshot

rmfakecloud’s web interface

This page will guide you through the steps needed to connect your device to an rmfakecloud server using Toltec.

*Note: You can only be connected to one server at a time.*
*You will not be able to connect to the reMarkable cloud service and an rmfakecloud server simultaneously.*
*It is easy to* `switch between servers <#switching-to-a-different-server>`_, *though.*

Before Getting Started
----------------------

First, make sure you **have access to an account on any rmfakecloud instance**.
You can set up your own instance by following the `instructions from the repository <https://github.com/ddvk/rmfakecloud>`_.
Take note of the server address; in the following, we’ll use ``https://rmfakecloud.example.com`` as an example server address.

It’s also a good idea to **make a full backup of your data** before following the steps below.
Make sure you’ve synced your documents with the reMarkable cloud service, as you will get disconnected during the process.
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.

Installing the Proxy
--------------------

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.
Fortunately, Toltec provides a package that automates all these steps for you.
Start an `SSH session <https://remarkablewiki.com/tech/ssh>`_ to your device and type the following command at the prompt::

opkg install rmfakecloud-proxy

Once the package is installed, select a server to connect to::

rmfakecloudctl set-upstream https://rmfakecloud.example.com

Finally, run the command below to switch to that server.
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::

rmfakecloudctl enable

If all goes well, you should get a message saying *“rmfakecloud-proxy is now enabled”* in your terminal.

Logging in to Your Account
--------------------------

Congratulations, your device is now talking to your rmfakecloud server of choice!
The last remaining step is to login to your account exactly as if you were connecting to your reMarkable account.

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.
On your device, go to *Menu > Settings > Account > Connect to reMarkable cloud > Connect*, then input that code.

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.

Switching to a Different Server
-------------------------------

Once the rmfakecloud proxy is setup on your device, you can switch to any other rmfakecloud instance by doing::

rmfakecloud set-upstream https://other-rmfakecloud.example.com

Each server switch will disconnect you from the cloud, so you’ll need to log back in to your respective accounts.

Reverting Back to the reMarkable Servers
----------------------------------------

It’s easy to revert back to syncing with the reMarkable cloud service, just run the following command::

rmfakecloud disable

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.
1 change: 1 addition & 0 deletions src/sitemap.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. toctree::

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