Skip to content

Kiwix

Kiwix serves offline copies of Wikipedia, Project Gutenberg, iFixit and other books. This shows the books with their article counts and a random article with its first paragraph, a new one each hour, and puts the library in ⌘K’s search. The assistant can search it and read an article to answer from, with the link to cite.

config.yaml
integrations:
kiwix:
type: kiwix
url: http://10.0.0.20:8080
href: https://library.example.com
layout:
- title: Apps
widgets:
- kiwix.library
OptionTypeDefaultWhat it does
urlURLrequiredwhere kiwix-serve answers, from Valet’s side
hrefstringoptionalwhere articles open, when that differs from url
bookslist of stringoptionalonly these books, by name (wikipedia_en_all_maxi, ifixit_en_all) or as in their address; every book by default
randomstringoptionalthe book the Random article card picks from: Wikipedia if there is one, else the biggest
headersmap of string{}sent with every request, for a server behind basic auth or a proxy: { Authorization: “Basic ${KIWIX_AUTH}” }

2 widgets. Each key starts with your instance name, here kiwix.

kiwix.library · list card · refreshes every 30 minutes while the page is open.

Kiwix, Library, small size
Small
Kiwix, Library, wide size
Wide
Kiwix, Library, medium size
Medium
Kiwix, Library, large size
Large
Kiwix, Library, in chat
In chat

Tall draws the same as medium, so it isn't shown. Only the empty space changes.

Kiwix Library: No books yet
No books yet
Kiwix Library: Can't reach it
Can't reach it

kiwix.random · article card · refreshes every hour while the page is open.

Kiwix, Random article, medium size
Medium
Kiwix, Random article, tall size
Tall
Kiwix, Random article, large size
Large
Kiwix, Random article, in chat
In chat

Small draws the same as medium. Wide draws the same as medium, so they aren't shown. Only the empty space changes.

Kiwix Random article: Can't reach it
Can't reach it

What the assistant can use, once its access level allows it. Read tools run freely. Everything else asks first.

ToolAccessWhat it does
kiwix_searchreadSearch the homelab’s offline library (Kiwix: copies of Wikipedia, WikiMed, iFixit repair guides, Project Gutenberg books and the like, whichever are installed) for articles.
kiwix_readreadRead one article from the homelab’s offline library (Kiwix) as plain text, to answer from it and cite it.