Unearthed · Reading guides
Updated
Unearthed Online is open source
Unearthed Online, the web application at unearthed.app, is open source under GPL-3.0. The Unearthed browser extension, Obsidian plugin and KOReader plugin also have code you can read on GitHub. Local and Mobile are separate paid apps.
Which apps are open source?
Unearthed Online is licensed under GPL-3.0. The browser extension, Obsidian plugin and KOReader plugin also have public GitHub repositories, each with its own license. Local and Mobile are separate paid products with their own licensing.
| App | What it does | Source code and pricing |
|---|---|---|
| Unearthed Online | Hosted highlight library and integrations | Public GPL-3.0 code; hosted service has a subscription |
| Browser extension | Kindle Notebook to Online | Public repository; used with Online |
| Obsidian plugin | Online library to an Obsidian vault | Public repository; Local exports without this plugin |
| KOReader plugin | KOReader annotations to Local or Online | Public repository; requires a receiving Unearthed edition |
| Unearthed Local and Mobile | Desktop library and phone companion | Separate paid products with their own licenses |
Documentation and links
How the apps work together
The browser extension brings Kindle Notebook highlights into Online, and the KOReader plugin does the same for books you read in KOReader. From there, use the Obsidian plugin to save them to your vault, or connect Notion to sync them to your workspace. You can also send daily reflections to Supernotes. Capacities is coming soon.
Read the code or contribute a fix
You’ll find the repositories below, along with their setup instructions and licenses. If something isn’t working, open an issue in the relevant repository. Fixes and improvements are welcome too.
Why does Online have a subscription?
The subscription is for the hosted service at unearthed.app. The source code is available under GPL-3.0, but running your own copy means providing the database, hosting and connected services yourself. If you prefer an app you can install on your computer with a one time payment, take a look at Local.
Running your own copy of Online
You can run your own copy of Unearthed Online using its open source code. You’ll be responsible for hosting, backups, updates and the services your copy uses. This requires web development experience. If you’d rather leave that to us, use the hosted service at unearthed.app. Setup instructions are in the repository README.
Documentation and links
When is Local the simpler choice?
If you want a library on your computer with Obsidian or Craft export, Local is easier to get started with. Install the app, import your highlights and choose where to export them. You won’t need to set up or maintain a web server. Choose our hosted Online service if you want its web library and integrations without running it yourself.