nvrl
7f8d625a8d
A `!` now means force or everything and nothing else (`:w!`, `:search!`, `:export!`, `:logout!`). A command that did a second thing behind its bang takes a word for it instead: `:space new|name|rm`, `:list name|rm`, `:task [add]|edit`, `:upload seal`, `:import zip [/]`. `:card` while reading a document makes a card about it, so `:card!` is gone. Merged: `:export` downloads what has focus, a file as it is or a document as markdown (`:download` folded in); `:share [off|new]` replaces `:unshare` and `:link`, and the list's `s` and `y` give way to it and the info sheet; `:noh` replaces `:clear`; `:vault [unlock|lock|passwd]` replaces `:unlock`, `:lock` and `:passwd`; Esc in the list puts down what `m` picked up before it closes the document, replacing `:unmark`. The old spellings run as their new lines for one release through a table in commands.ts; help and Tab leave them out, and the wiki lists them. A settings sheet (`,` or `:settings`) holds the options, the vault, the backup, the signed-in browsers, ssh keys and capture tokens. Each row runs the command a line would. Bare `:set`, `:vault`, `:backup`, `:sessions`, `:sshkey` and `:token` open it at their part. `?` shows the keys and commands to start with, flagged in the keymap and the command table; a second `?` (or `:help all`) shows all of them, and a filter always searches all of them. Help rows are keyed by key and description, as two contexts can share a label.
4.0 KiB
Backup and mail
Backing up to Proton Drive
The server can mirror its data directory into Proton Drive, where it appears as a device of its own, beside the desktop clients. Everything is encrypted before it leaves the machine, by the same Rust SDK the Linux client uses, so Proton stores a workspace it cannot read.
It is a third-party client. It names itself to Proton as
external-drive-narl_workspace@<version>-alpha, carries no Proton branding,
and is not supported by Proton.
Logging in
Once, from the workspace:
:backup login <proton-username>
It shows the disclosure above and asks before anything else, then asks for the password and, when the account has one, the two-factor code. If Proton wants a human check first, its own page opens in a sheet. An account whose only second factor is a security key cannot log in from here; add an authenticator app to it. The mirror starts within a minute; no restart is needed.
The same login runs from the server's terminal:
narl-workspace proton-login
docker compose exec -it workspace narl-workspace proton-login # in Docker
The password itself is never stored, only the session and the key passphrases
derived at login. They are kept as a 0600 file next to the database, or in
the OS keyring with --features keyring. In a container,
WORKSPACE_SESSION_KEY_FILE seals that file under a key kept off the data
volume, such as a Docker secret.
What it does
The mirror is one-way and runs after changes: once the workspace has been
quiet for WORKSPACE_BACKUP_DEBOUNCE_SEC, with WORKSPACE_BACKUP_INTERVAL_MIN
as a backstop. An hour of writing is one backup, not sixty.
narl-workspace/ the device
data/ the data directory, copied
RESTORE.txt what this is, and how to put it back
diary.db a consistent snapshot
uploads/<uuid> every uploaded file
files/ every file in the tree again, as <space>/<folder>/<name>
diary.dbbecomes a new revision on Drive each time, so Proton keeps the older ones and a mistake that was mirrored can still be undone.files/is for reading on Drive by name. It follows renames and moves.- Restoring is copying the contents of
data/into an empty data directory. - A delete here does not delete on Drive unless
WORKSPACE_BACKUP_PRUNEis on.
| command | what it does |
|---|---|
:backup |
the backup in the settings sheet (,): when the last one finished, and whether it failed; Enter there runs one |
:backup! |
run one now |
:backup logout |
forget the session; the mirror stays where it is |
narl-workspace proton-status |
account, device, schedule, how much is mirrored |
narl-workspace backup-now |
mirror once and exit, for cron |
Mail is off until WORKSPACE_SMTP_URL is set. Then four kinds of plain-text
mail go to WORKSPACE_MAIL_TO:
| kind | when |
|---|---|
reminder |
at WORKSPACE_REMINDER_AT, when nothing was written in the diary that day |
card_due |
at WORKSPACE_CARD_DUE_AT, for every card due that day, and again once it is overdue |
digest |
at WORKSPACE_DIGEST_AT: what was written in each space, what was finished, what is still open |
login |
a browser that has not signed in before signed in, or a run of wrong passwords |
WORKSPACE_MAIL_KINDS lists the kinds that may be sent. Every "today" is
counted in WORKSPACE_TIMEZONE.
Mail goes through an outbox: a restart cannot send yesterday's reminder twice, and a relay that refuses cannot lose one. It is retried with a widening gap, up to an hour apart, and given up after ten refusals. A card mail is checked against its card before it goes, so a card finished since is not mailed.
narl-workspace mail-test # one mail, straight out
narl-workspace mail-status # what is configured, queued and failed
compose.override.yml.example has a mailpit
service for trying the settings out: point WORKSPACE_SMTP_URL at
smtp://mailpit:1025 and read the mail at http://127.0.0.1:8025.