User manual
For the person who runs Inkhold, and for everyone in the house who uses it, on the tablet or in a browser.
Tutorials
Lessons: start here.
How-to: running Inkhold
Steps for the person who runs the server.
- Install with Docker or Podman Run Inkhold's container image, with its data and settings kept outside it.
- Install the binary Install the release binary and run it as a service.
- Put it behind HTTPS Serve Inkhold over HTTPS, with its own certificate or behind a reverse proxy.
- Add a household member Create an account for someone in the house, and reset a forgotten password.
- Set allotments and the bin's window Give each person a storage allotment, and choose how long the bin keeps what they delete.
- Back up automatically Take backups on a schedule and check that they can be restored.
- Restore from a backup Bring the whole library back to a snapshot.
- Move Inkhold to a new machine Move the library, accounts and devices to another computer.
- Upgrade Inkhold Upgrade to a new release safely, with a backup first.
- Turn on To-Do sync Let the tablet's To-Do lists sync, and choose Retain locally when the tablet asks.
How-to: using Inkhold
Steps for everyone who uses it, on the tablet or in a browser.
- Point your Supernote at Inkhold Sign the tablet in to Inkhold instead of Supernote's cloud.
- Find a note Search names, handwriting, PDFs and text files, and see which notes can't be searched.
- Read a note Open a notebook in the browser: its layers, find in it, zoom, page through.
- Work through a PDF Use a PDF's contents, select and copy its text, jump to a page, see which pages you wrote on.
- Get back a deleted file Restore a file from the recycle bin before the bin empties it.
- Go back to an earlier version Look at a file's earlier versions and restore one.
- Export a note Save a notebook, or one page, as a PDF with searchable text, a flat PNG, or a layered .ora.
- Use To-Do in the browser See, add, tick off and move the tablet's to-dos from a browser.
- Install Inkhold on your phone Add Inkhold to your phone's home screen and use it like an app.
Reference
Facts to look up.
- config.zon settings Every setting in config.zon, its default, and what it changes. Generated from config.example.zon.
- Command line Every command and option of the inkhold binary. Generated from --help.
- File types Which files open in the browser, which are searchable, and what each exports to.
- Devices Which Supernote models are tested, and how to report on one that isn't.
- What doesn't work yet The gaps, plainly: what Inkhold can't do today, and why.
- Keyboard shortcuts Every keyboard shortcut in the library, the viewers and To-Do.
- Requirements The hardware, operating systems and browsers Inkhold runs on.
Explanation
Why things are the way they are.
- How Inkhold works The server only stores and moves bytes; your browser draws, searches and exports.
- How syncing works What happens when the tablet syncs, by hand or with Auto Sync.
- Your data Where your notes are kept, who can see them, and what never leaves your home.
- How backups work Snapshots, the shared blob store, and why a backup can be checked without restoring it.
- How search works Where the searchable text comes from, why the index lives in your browser, and what can't be searched.
- Why nothing is deleted outright The recycle bin, version history, and the rule that Inkhold never loses a file.